/** * | key | description | * | :---------------------- | :-------------------------------------- | * | IBM037 | IBM EBCDIC (US-Canada) | * | IBM437 | OEM United States | * | IBM500 | IBM EBCDIC (International) | * | ASMO-708 | Arabic (ASMO 708) | * | DOS-720 | Arabic (DOS) | * | ibm737 | Greek (DOS) | * | ibm775 | Baltic (DOS) | * | ibm850 | Western European (DOS) | * | ibm852 | Central European (DOS) | * | IBM855 | OEM Cyrillic | * | ibm857 | Turkish (DOS) | * | IBM00858 | OEM Multilingual Latin I | * | IBM860 | Portuguese (DOS) | * | ibm861 | Icelandic (DOS) | * | DOS-862 | Hebrew (DOS) | * | IBM863 | French Canadian (DOS) | * | IBM864 | Arabic (864) | * | IBM865 | Nordic (DOS) | * | cp866 | Cyrillic (DOS) | * | ibm869 | Greek, Modern (DOS) | * | IBM870 | IBM EBCDIC (Multilingual Latin-2) | * | windows-874 | Thai (Windows) | * | cp875 | IBM EBCDIC (Greek Modern) | * | shift_jis | Japanese (Shift-JIS) | * | gb2312 | Chinese Simplified (GB2312) | * | ks_c_5601-1987 | Korean | * | big5 | Chinese Traditional (Big5) | * | IBM1026 | IBM EBCDIC (Turkish Latin-5) | * | IBM01047 | IBM Latin-1 | * | IBM01140 | IBM EBCDIC (US-Canada-Euro) | * | IBM01141 | IBM EBCDIC (Germany-Euro) | * | IBM01142 | IBM EBCDIC (Denmark-Norway-Euro) | * | IBM01143 | IBM EBCDIC (Finland-Sweden-Euro) | * | IBM01144 | IBM EBCDIC (Italy-Euro) | * | IBM01145 | IBM EBCDIC (Spain-Euro) | * | IBM01146 | IBM EBCDIC (UK-Euro) | * | IBM01147 | IBM EBCDIC (France-Euro) | * | IBM01148 | IBM EBCDIC (International-Euro) | * | IBM01149 | IBM EBCDIC (Icelandic-Euro) | * | utf-16 | Unicode | * | unicodeFFFE | Unicode (Big endian) | * | windows-1250 | Central European (Windows) | * | windows-1251 | Cyrillic (Windows) | * | Windows-1252 | Western European (Windows) | * | windows-1253 | Greek (Windows) | * | windows-1254 | Turkish (Windows) | * | windows-1255 | Hebrew (Windows) | * | windows-1256 | Arabic (Windows) | * | windows-1257 | Baltic (Windows) | * | windows-1258 | Vietnamese (Windows) | * | Johab | Korean (Johab) | * | macintosh | Western European (Mac) | * | x-mac-japanese | Japanese (Mac) | * | x-mac-chinesetrad | Chinese Traditional (Mac) | * | x-mac-korean | Korean (Mac) | * | x-mac-arabic | Arabic (Mac) | * | x-mac-hebrew | Hebrew (Mac) | * | x-mac-greek | Greek (Mac) | * | x-mac-cyrillic | Cyrillic (Mac) | * | x-mac-chinesesimp | Chinese Simplified (Mac) | * | x-mac-romanian | Romanian (Mac) | * | x-mac-ukrainian | Ukrainian (Mac) | * | x-mac-thai | Thai (Mac) | * | x-mac-ce | Central European (Mac) | * | x-mac-icelandic | Icelandic (Mac) | * | x-mac-turkish | Turkish (Mac) | * | x-mac-croatian | Croatian (Mac) | * | utf-32 | Unicode (UTF-32) | * | utf-32BE | Unicode (UTF-32 Big endian) | * | x-Chinese-CNS | Chinese Traditional (CNS) | * | x-cp20001 | TCA Taiwan | * | x-Chinese-Eten | Chinese Traditional (Eten) | * | x-cp20003 | IBM5550 Taiwan | * | x-cp20004 | TeleText Taiwan | * | x-cp20005 | Wang Taiwan | * | x-IA5 | Western European (IA5) | * | x-IA5-German | German (IA5) | * | x-IA5-Swedish | Swedish (IA5) | * | x-IA5-Norwegian | Norwegian (IA5) | * | us-ascii | US-ASCII | * | x-cp20261 | T.61 | * | x-cp20269 | ISO-6937 | * | IBM273 | IBM EBCDIC (Germany) | * | IBM277 | IBM EBCDIC (Denmark-Norway) | * | IBM278 | IBM EBCDIC (Finland-Sweden) | * | IBM280 | IBM EBCDIC (Italy) | * | IBM284 | IBM EBCDIC (Spain) | * | IBM285 | IBM EBCDIC (UK) | * | IBM290 | IBM EBCDIC (Japanese katakana) | * | IBM297 | IBM EBCDIC (France) | * | IBM420 | IBM EBCDIC (Arabic) | * | IBM423 | IBM EBCDIC (Greek) | * | IBM424 | IBM EBCDIC (Hebrew) | * | x-EBCDIC-KoreanExtended | IBM EBCDIC (Korean Extended) | * | IBM-Thai | IBM EBCDIC (Thai) | * | koi8-r | Cyrillic (KOI8-R) | * | IBM871 | IBM EBCDIC (Icelandic) | * | IBM880 | IBM EBCDIC (Cyrillic Russian) | * | IBM905 | IBM EBCDIC (Turkish) | * | IBM00924 | IBM Latin-1 | * | EUC-JP | Japanese (JIS 0208-1990 and 0212-1990) | * | x-cp20936 | Chinese Simplified (GB2312-80) | * | x-cp20949 | Korean Wansung | * | cp1025 | IBM EBCDIC (Cyrillic Serbian-Bulgarian) | * | koi8-u | Cyrillic (KOI8-U) | * | iso-8859-1 | Western European (ISO) | * | iso-8859-2 | Central European (ISO) | * | iso-8859-3 | Latin 3 (ISO) | * | iso-8859-4 | Baltic (ISO) | * | iso-8859-5 | Cyrillic (ISO) | * | iso-8859-6 | Arabic (ISO) | * | iso-8859-7 | Greek (ISO) | * | iso-8859-8 | Hebrew (ISO-Visual) | * | iso-8859-9 | Turkish (ISO) | * | iso-8859-13 | Estonian (ISO) | * | iso-8859-15 | Latin 9 (ISO) | * | x-Europa | Europa | * | iso-8859-8-i | Hebrew (ISO-Logical) | * | iso-2022-jp | Japanese (JIS) | * | csISO2022JP | Japanese (JIS-Allow 1 byte Kana) | * | iso-2022-kr | Korean (ISO) | * | x-cp50227 | Chinese Simplified (ISO-2022) | * | euc-jp | Japanese (EUC) | * | EUC-CN | Chinese Simplified (EUC) | * | euc-kr | Korean (EUC) | * | hz-gb-2312 | Chinese Simplified (HZ) | * | GB18030 | Chinese Simplified (GB18030) | * | x-iscii-de | ISCII Devanagari | * | x-iscii-be | ISCII Bengali | * | x-iscii-ta | ISCII Tamil | * | x-iscii-te | ISCII Telugu | * | x-iscii-as | ISCII Assamese | * | x-iscii-or | ISCII Oriya | * | x-iscii-ka | ISCII Kannada | * | x-iscii-ma | ISCII Malayalam | * | x-iscii-gu | ISCII Gujarati | * | x-iscii-pa | ISCII Punjabi | * | utf-7 | Unicode (UTF-7) | * | utf-8 | Unicode (UTF-8) | * | utf-8-without-BOM | Unicode (UTF-8 without BOM) | */ export type ExportSettingsEncoding = "IBM037" | "IBM437" | "IBM500" | "ASMO-708" | "DOS-720" | "ibm737" | "ibm775" | "ibm850" | "ibm852" | "IBM855" | "ibm857" | "IBM00858" | "IBM860" | "ibm861" | "DOS-862" | "IBM863" | "IBM864" | "IBM865" | "cp866" | "ibm869" | "IBM870" | "windows-874" | "cp875" | "shift_jis" | "gb2312" | "ks_c_5601-1987" | "big5" | "IBM1026" | "IBM01047" | "IBM01140" | "IBM01141" | "IBM01142" | "IBM01143" | "IBM01144" | "IBM01145" | "IBM01146" | "IBM01147" | "IBM01148" | "IBM01149" | "utf-16" | "unicodeFFFE" | "windows-1250" | "windows-1251" | "Windows-1252" | "windows-1253" | "windows-1254" | "windows-1255" | "windows-1256" | "windows-1257" | "windows-1258" | "Johab" | "macintosh" | "x-mac-japanese" | "x-mac-chinesetrad" | "x-mac-korean" | "x-mac-arabic" | "x-mac-hebrew" | "x-mac-greek" | "x-mac-cyrillic" | "x-mac-chinesesimp" | "x-mac-romanian" | "x-mac-ukrainian" | "x-mac-thai" | "x-mac-ce" | "x-mac-icelandic" | "x-mac-turkish" | "x-mac-croatian" | "utf-32" | "utf-32BE" | "x-Chinese-CNS" | "x-cp20001" | "x-Chinese-Eten" | "x-cp20003" | "x-cp20004" | "x-cp20005" | "x-IA5" | "x-IA5-German" | "x-IA5-Swedish" | "x-IA5-Norwegian" | "us-ascii" | "x-cp20261" | "x-cp20269" | "IBM273" | "IBM277" | "IBM278" | "IBM280" | "IBM284" | "IBM285" | "IBM290" | "IBM297" | "IBM420" | "IBM423" | "IBM424" | "x-EBCDIC-KoreanExtended" | "IBM-Thai" | "koi8-r" | "IBM871" | "IBM880" | "IBM905" | "IBM00924" | "EUC-JP" | "x-cp20936" | "x-cp20949" | "cp1025" | "koi8-u" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-13" | "iso-8859-15" | "x-Europa" | "iso-8859-8-i" | "iso-2022-jp" | "csISO2022JP" | "iso-2022-kr" | "x-cp50227" | "euc-jp" | "EUC-CN" | "euc-kr" | "hz-gb-2312" | "GB18030" | "x-iscii-de" | "x-iscii-be" | "x-iscii-ta" | "x-iscii-te" | "x-iscii-as" | "x-iscii-or" | "x-iscii-ka" | "x-iscii-ma" | "x-iscii-gu" | "x-iscii-pa" | "utf-7" | "utf-8" | "utf-8-without-BOM"; /** * | key | description | * | :----------- | :----------- | * | Transitional | Transitional | * | Strict | Strict | */ export type ExportSettingsOpenXmlStandard = "Transitional" | "Strict"; /** * | key | description | * | :-------- | :-------- | * | Default | Default | * | Portrait | Portrait | * | Landscape | Landscape | */ export type ExportSettingsOrientation = "Default" | "Portrait" | "Landscape"; /** * | key | description | * | :--------------------------------- | :----------------------------------------------- | * | Default | Default | * | Letter | Letter (8.5" x 11") | * | LetterSmall | Letter Small (8.5" x 11") | * | Tabloid | Tabloid (11" x 17") | * | Ledger | Ledger (17" x 11") | * | Legal | Legal (8.5" x 14") | * | Statement | Statement (5.5" x 8.5") | * | Executive | Executive (7.25" x 10.5") | * | A3 | A3 (29.7cm x 42cm) | * | A4 | A4 (21cm x 29.7cm) | * | A4Small | A4 Small (21cm x 29.7cm) | * | A5 | A5 (14.8cm x 21cm) | * | B4 | B4 (25cm x 35.3cm) | * | B5 | B5 (17.6cm x 25cm) | * | Folio | Folio (8.5" x 13") | * | Quarto | Quarto (21.5cm x 27.5cm) | * | Standard10x14 | Standard (10" x 14") | * | Standard11x17 | Standard (11" x 17") | * | Note | Note (8.5" x 11") | * | Number9Envelope | #9 Envelope (3.875" x 8.875") | * | Number10Envelope | #10 Envelope (4.125" x 9.5") | * | Number11Envelope | #11 Envelope (4.5" x 10.375") | * | Number12Envelope | #12 Envelope (4.75" x 11") | * | Number14Envelope | #14 Envelope (5" x 11.5") | * | CSheet | C (17" x 22") | * | DSheet | D (22" x 34") | * | ESheet | E (34" x 44") | * | DLEnvelope | DL Envelope (11cm x 22cm) | * | C5Envelope | C5 Envelope (16.2cm x 22.9cm) | * | C3Envelope | C3 Envelope (32.4cm x 45.8cm) | * | C4Envelope | C4 Envelope (22.9cm x 32.4cm) | * | C6Envelope | C6 Envelope (11.4cm x 16.2cm) | * | C65Envelope | C65 Envelope (11.4cm x 22.9cm) | * | B4Envelope | B4 Envelope (25cm x 35.3cm) | * | B5Envelope | B5 Envelope (17.6cm x 25cm) | * | B6Envelope | B6 Envelope (17.6cm x 12.5cm) | * | ItalyEnvelope | Italy Envelope (11cm x 23cm) | * | MonarchEnvelope | Monarch Envelope (3.875" x 7.5") | * | PersonalEnvelope | 6 3/4 Envelope (3.625" x 6.5") | * | USStandardFanfold | US Standard Fanfold (14.875" x 11") | * | GermanStandardFanfold | German Standard Fanfold (8.5" x 12") | * | GermanLegalFanfold | German Legal Fanfold (8.5" x 13") | * | IsoB4 | ISO B4 (25cm x 35.3cm) | * | JapanesePostcard | Japanese Postcard (10cm x 14.8cm) | * | Standard9x11 | Standard (9" x 11") | * | Standard10x11 | Standard (10" x 11") | * | Standard15x11 | Standard (15" x 11") | * | InviteEnvelope | Invitation Envelope (22cm x 22cm) | * | LetterExtra | Letter Extra (9.275" x 12") | * | LegalExtra | Legal Extra (9.275" x 15") | * | TabloidExtra | Tabloid Extra (11.69" x 18") | * | A4Extra | A4 Extra (23.6cm x 32.2cm) | * | LetterTransverse | Letter Transverse (8.275" x 11") | * | A4Transverse | A4 Transverse (21cm x 29.7cm) | * | LetterExtraTransverse | Letter Extra Transverse (9.275" x 12") | * | APlus | SuperA/SuperA/A4 (22.7cm x 35.6cm) | * | BPlus | SuperB/SuperB/A3 (30.5cm x 48.7cm) | * | LetterPlus | Letter Plus (8.5" x 12.69") | * | A4Plus | A4 Plus (21cm x 33cm) | * | A5Transverse | A5 Transverse (14.8cm x 21cm) | * | B5Transverse | JIS B5 Transverse (18.2cm x 25.7cm) | * | A3Extra | A3 Extra (32.2cm x 44.5cm) | * | A5Extra | A5 Extra (17.4cm x 23.5cm) | * | B5Extra | B5 Extra (20.1cm x 27.6cm) | * | A2 | A2 (42cm x 59.4cm) | * | A3Transverse | A3 Transverse (29.7cm x 42cm) | * | A3ExtraTransverse | A3 Extra Transverse (32.2cm x 44.5cm) | * | JapaneseDoublePostcard | Japanese Double Postcard (20cm x 14.8cm) | * | A6 | A6 (10.5cm x 14.8cm) | * | JapaneseEnvelopeKakuNumber2 | Japanese Kaku #2 Envelope | * | JapaneseEnvelopeKakuNumber3 | Japanese Kaku #3 Envelope | * | JapaneseEnvelopeChouNumber3 | Japanese Chou #3 Envelope | * | JapaneseEnvelopeChouNumber4 | Japanese Chou #4 Envelope | * | LetterRotated | Letter Rotated (11" x 8.5") | * | A3Rotated | A3 Rotated (42cm x 29.7cm) | * | A4Rotated | A4 Rotated (29.7cm x 21cm) | * | A5Rotated | A5 Rotated (21cm x 14.8cm) | * | B4JisRotated | JIS B4 Rotated (36.4cm x 25.7cm) | * | B5JisRotated | JIS B5 Rotated (25.7cm x 18.2cm) | * | JapanesePostcardRotated | Japanese Rotated Postcard (14.8cm x 10cm) | * | JapaneseDoublePostcardRotated | Japanese Rotated Double Postcard (14.8cm x 20cm) | * | A6Rotated | A6 Rotated (14.8cm x 10.5cm) | * | JapaneseEnvelopeKakuNumber2Rotated | Japanese Rotated Kaku #2 Envelope | * | JapaneseEnvelopeKakuNumber3Rotated | Japanese Rotated Kaku #3 Envelope | * | JapaneseEnvelopeChouNumber3Rotated | Japanese Rotated Chou #3 Envelope | * | JapaneseEnvelopeChouNumber4Rotated | Japanese Rotated Chou #4 Envelope | * | B6Jis | JIS B6 (12.8cm x 18.2cm) | * | B6JisRotated | JIS B6 Rotated (18.2cm x 12.8cm) | * | Standard12x11 | Standard (12" x 11") | * | JapaneseEnvelopeYouNumber4 | Japanese You #4 Envelope | * | JapaneseEnvelopeYouNumber4Rotated | Japanese You #4 Rotated Envelope | * | Prc16K | 16K (14.6cm x 21.5cm) | * | Prc32K | 32K (9.7cm x 15.1cm) | * | Prc32KBig | 32K Big (9.7cm x 15.1cm) | * | PrcEnvelopeNumber1 | #1 Envelope (10.2cm x 16.5cm) | * | PrcEnvelopeNumber2 | #2 Envelope (10.2cm x 17.6cm) | * | PrcEnvelopeNumber3 | #3 Envelope (12.5cm x 17.6cm) | * | PrcEnvelopeNumber4 | #4 Envelope (11cm x 20.8cm) | * | PrcEnvelopeNumber5 | #5 Envelope (11cm x 22cm) | * | PrcEnvelopeNumber6 | #6 Envelope (12cm x 23cm) | * | PrcEnvelopeNumber7 | #7 Envelope (16cm x 23cm) | * | PrcEnvelopeNumber8 | #8 Envelope (12cm x 30.9cm) | * | PrcEnvelopeNumber9 | #9 Envelope (22.9cm x 32.4cm) | * | PrcEnvelopeNumber10 | #10 Envelope (32.4cm x 45.8cm) | * | Prc16KRotated | 16K Rotated (14.6cm x 21.5cm) | * | Prc32KRotated | 32K Rotated (9.7cm x 15.1cm) | * | Prc32KBigRotated | 32K Big Rotated (9.7cm x 15.1cm) | * | PrcEnvelopeNumber1Rotated | #1 Rotated Envelope (16.5cm x 10.2cm) | * | PrcEnvelopeNumber2Rotated | #2 Rotated Envelope (17.6cm x 10.2cm) | * | PrcEnvelopeNumber3Rotated | #3 Rotated Envelope (17.6cm x 12.5cm) | * | PrcEnvelopeNumber4Rotated | #4 Rotated Envelope (20.8cm x 11cm) | * | PrcEnvelopeNumber5Rotated | #5 Rotated Envelope (22cm x 11cm) | * | PrcEnvelopeNumber6Rotated | #6 Rotated Envelope (23cm x 12cm) | * | PrcEnvelopeNumber7Rotated | #7 Rotated Envelope (23cm x 16cm) | * | PrcEnvelopeNumber8Rotated | #8 Rotated Envelope (30.9cm x 12cm) | * | PrcEnvelopeNumber9Rotated | #9 Rotated Envelope (32.4cm x 22.9cm) | * | PrcEnvelopeNumber10Rotated | #10 Rotated Envelope (45.8cm x 32.4cm) | */ export type ExportSettingsPaperSize = "Default" | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quarto" | "Standard10x14" | "Standard11x17" | "Note" | "Number9Envelope" | "Number10Envelope" | "Number11Envelope" | "Number12Envelope" | "Number14Envelope" | "CSheet" | "DSheet" | "ESheet" | "DLEnvelope" | "C5Envelope" | "C3Envelope" | "C4Envelope" | "C6Envelope" | "C65Envelope" | "B4Envelope" | "B5Envelope" | "B6Envelope" | "ItalyEnvelope" | "MonarchEnvelope" | "PersonalEnvelope" | "USStandardFanfold" | "GermanStandardFanfold" | "GermanLegalFanfold" | "IsoB4" | "JapanesePostcard" | "Standard9x11" | "Standard10x11" | "Standard15x11" | "InviteEnvelope" | "LetterExtra" | "LegalExtra" | "TabloidExtra" | "A4Extra" | "LetterTransverse" | "A4Transverse" | "LetterExtraTransverse" | "APlus" | "BPlus" | "LetterPlus" | "A4Plus" | "A5Transverse" | "B5Transverse" | "A3Extra" | "A5Extra" | "B5Extra" | "A2" | "A3Transverse" | "A3ExtraTransverse" | "JapaneseDoublePostcard" | "A6" | "JapaneseEnvelopeKakuNumber2" | "JapaneseEnvelopeKakuNumber3" | "JapaneseEnvelopeChouNumber3" | "JapaneseEnvelopeChouNumber4" | "LetterRotated" | "A3Rotated" | "A4Rotated" | "A5Rotated" | "B4JisRotated" | "B5JisRotated" | "JapanesePostcardRotated" | "JapaneseDoublePostcardRotated" | "A6Rotated" | "JapaneseEnvelopeKakuNumber2Rotated" | "JapaneseEnvelopeKakuNumber3Rotated" | "JapaneseEnvelopeChouNumber3Rotated" | "JapaneseEnvelopeChouNumber4Rotated" | "B6Jis" | "B6JisRotated" | "Standard12x11" | "JapaneseEnvelopeYouNumber4" | "JapaneseEnvelopeYouNumber4Rotated" | "Prc16K" | "Prc32K" | "Prc32KBig" | "PrcEnvelopeNumber1" | "PrcEnvelopeNumber2" | "PrcEnvelopeNumber3" | "PrcEnvelopeNumber4" | "PrcEnvelopeNumber5" | "PrcEnvelopeNumber6" | "PrcEnvelopeNumber7" | "PrcEnvelopeNumber8" | "PrcEnvelopeNumber9" | "PrcEnvelopeNumber10" | "Prc16KRotated" | "Prc32KRotated" | "Prc32KBigRotated" | "PrcEnvelopeNumber1Rotated" | "PrcEnvelopeNumber2Rotated" | "PrcEnvelopeNumber3Rotated" | "PrcEnvelopeNumber4Rotated" | "PrcEnvelopeNumber5Rotated" | "PrcEnvelopeNumber6Rotated" | "PrcEnvelopeNumber7Rotated" | "PrcEnvelopeNumber8Rotated" | "PrcEnvelopeNumber9Rotated" | "PrcEnvelopeNumber10Rotated"; /** * | key | description | * | :------------------------------------ | :------------------------------------------ | * | OneLogicalPageOnSinglePhysicalPage | One Logical Page On Single Physical Page | * | TwoLogicalPagesOnSinglePhysicalPage | Two Logical Pages On Single Physical Page | * | FourLogicalPagesOnSinglePhysicalPage | Four Logical Pages On Single Physical Page | * | EightLogicalPagesOnSinglePhysicalPage | Eight Logical Pages On Single Physical Page | * | BookletMode | Booklet Mode | */ export type ExportSettingsPrintLayoutMode = "OneLogicalPageOnSinglePhysicalPage" | "TwoLogicalPagesOnSinglePhysicalPage" | "FourLogicalPagesOnSinglePhysicalPage" | "EightLogicalPagesOnSinglePhysicalPage" | "BookletMode"; /** * | key | description | * | :------------------- | :------------------- | * | Transparent | Transparent | * | Black | Black | * | DarkSlateGray | DarkSlateGray | * | SlateGray | SlateGray | * | LightSlateGray | LightSlateGray | * | DimGray | DimGray | * | Gray | Gray | * | DarkGray | DarkGray | * | Silver | Silver | * | LightGrey | LightGrey | * | Gainsboro | Gainsboro | * | WhiteSmoke | WhiteSmoke | * | White | White | * | Snow | Snow | * | HoneyDew | HoneyDew | * | MintCream | MintCream | * | Azure | Azure | * | AliceBlue | AliceBlue | * | GhostWhite | GhostWhite | * | SeaShell | SeaShell | * | Beige | Beige | * | OldLace | OldLace | * | FloralWhite | FloralWhite | * | Ivory | Ivory | * | AntiqueWhite | AntiqueWhite | * | Linen | Linen | * | LavenderBlush | LavenderBlush | * | MistyRose | MistyRose | * | Pink | Pink | * | LightPink | LightPink | * | HotPink | HotPink | * | DeepPink | DeepPink | * | PaleVioletRed | PaleVioletRed | * | MediumVioletRed | MediumVioletRed | * | LightSalmon | LightSalmon | * | Salmon | Salmon | * | DarkSalmon | DarkSalmon | * | LightCoral | LightCoral | * | IndianRed | IndianRed | * | Crimson | Crimson | * | FireBrick | FireBrick | * | DarkRed | DarkRed | * | Red | Red | * | OrangeRed | OrangeRed | * | Tomato | Tomato | * | Coral | Coral | * | DarkOrange | DarkOrange | * | Orange | Orange | * | Yellow | Yellow | * | LightYellow | LightYellow | * | LemonChiffon | LemonChiffon | * | LightGoldenrodYellow | LightGoldenrodYellow | * | PapayaWhip | PapayaWhip | * | Moccasin | Moccasin | * | PeachPuff | PeachPuff | * | PaleGoldenrod | PaleGoldenrod | * | Khaki | Khaki | * | DarkKhaki | DarkKhaki | * | Gold | Gold | * | Cornsilk | Cornsilk | * | BlanchedAlmond | BlanchedAlmond | * | Bisque | Bisque | * | NavajoWhite | NavajoWhite | * | Wheat | Wheat | * | BurlyWood | BurlyWood | * | Tan | Tan | * | RosyBrown | RosyBrown | * | SandyBrown | SandyBrown | * | Goldenrod | Goldenrod | * | DarkGoldenrod | DarkGoldenrod | * | Peru | Peru | * | Chocolate | Chocolate | * | SaddleBrown | SaddleBrown | * | Sienna | Sienna | * | Brown | Brown | * | Maroon | Maroon | * | DarkOliveGreen | DarkOliveGreen | * | Olive | Olive | * | OliveDrab | OliveDrab | * | YellowGreen | YellowGreen | * | LimeGreen | LimeGreen | * | Lime | Lime | * | LawnGreen | LawnGreen | * | Chartreuse | Chartreuse | * | GreenYellow | GreenYellow | * | SpringGreen | SpringGreen | * | MediumSpringGreen | MediumSpringGreen | * | LightGreen | LightGreen | * | PaleGreen | PaleGreen | * | DarkSeaGreen | DarkSeaGreen | * | MediumAquamarine | MediumAquamarine | * | MediumSeaGreen | MediumSeaGreen | * | SeaGreen | SeaGreen | * | ForestGreen | ForestGreen | * | Green | Green | * | DarkGreen | DarkGreen | * | Aqua | Aqua | * | Cyan | Cyan | * | LightCyan | LightCyan | * | PaleTurquoise | PaleTurquoise | * | Aquamarine | Aquamarine | * | Turquoise | Turquoise | * | MediumTurquoise | MediumTurquoise | * | DarkTurquoise | DarkTurquoise | * | LightSeaGreen | LightSeaGreen | * | CadetBlue | CadetBlue | * | DarkCyan | DarkCyan | * | Teal | Teal | * | LightSteelBlue | LightSteelBlue | * | PowderBlue | PowderBlue | * | LightBlue | LightBlue | * | SkyBlue | SkyBlue | * | LightSkyBlue | LightSkyBlue | * | DeepSkyBlue | DeepSkyBlue | * | DodgerBlue | DodgerBlue | * | CornflowerBlue | CornflowerBlue | * | SteelBlue | SteelBlue | * | RoyalBlue | RoyalBlue | * | Blue | Blue | * | MediumBlue | MediumBlue | * | DarkBlue | DarkBlue | * | Navy | Navy | * | MidnightBlue | MidnightBlue | * | Lavender | Lavender | * | Thistle | Thistle | * | Plum | Plum | * | Violet | Violet | * | Orchid | Orchid | * | Fuchsia | Fuchsia | * | Magenta | Magenta | * | MediumOrchid | MediumOrchid | * | MediumPurple | MediumPurple | * | BlueViolet | BlueViolet | * | DarkViolet | DarkViolet | * | DarkOrchid | DarkOrchid | * | DarkMagenta | DarkMagenta | * | Purple | Purple | * | Indigo | Indigo | * | DarkSlateBlue | DarkSlateBlue | * | RebeccaPurple | RebeccaPurple | * | SlateBlue | SlateBlue | * | MediumSlateBlue | MediumSlateBlue | */ export type ExportSettingsWatermarkColor = "Transparent" | "Black" | "DarkSlateGray" | "SlateGray" | "LightSlateGray" | "DimGray" | "Gray" | "DarkGray" | "Silver" | "LightGrey" | "Gainsboro" | "WhiteSmoke" | "White" | "Snow" | "HoneyDew" | "MintCream" | "Azure" | "AliceBlue" | "GhostWhite" | "SeaShell" | "Beige" | "OldLace" | "FloralWhite" | "Ivory" | "AntiqueWhite" | "Linen" | "LavenderBlush" | "MistyRose" | "Pink" | "LightPink" | "HotPink" | "DeepPink" | "PaleVioletRed" | "MediumVioletRed" | "LightSalmon" | "Salmon" | "DarkSalmon" | "LightCoral" | "IndianRed" | "Crimson" | "FireBrick" | "DarkRed" | "Red" | "OrangeRed" | "Tomato" | "Coral" | "DarkOrange" | "Orange" | "Yellow" | "LightYellow" | "LemonChiffon" | "LightGoldenrodYellow" | "PapayaWhip" | "Moccasin" | "PeachPuff" | "PaleGoldenrod" | "Khaki" | "DarkKhaki" | "Gold" | "Cornsilk" | "BlanchedAlmond" | "Bisque" | "NavajoWhite" | "Wheat" | "BurlyWood" | "Tan" | "RosyBrown" | "SandyBrown" | "Goldenrod" | "DarkGoldenrod" | "Peru" | "Chocolate" | "SaddleBrown" | "Sienna" | "Brown" | "Maroon" | "DarkOliveGreen" | "Olive" | "OliveDrab" | "YellowGreen" | "LimeGreen" | "Lime" | "LawnGreen" | "Chartreuse" | "GreenYellow" | "SpringGreen" | "MediumSpringGreen" | "LightGreen" | "PaleGreen" | "DarkSeaGreen" | "MediumAquamarine" | "MediumSeaGreen" | "SeaGreen" | "ForestGreen" | "Green" | "DarkGreen" | "Aqua" | "Cyan" | "LightCyan" | "PaleTurquoise" | "Aquamarine" | "Turquoise" | "MediumTurquoise" | "DarkTurquoise" | "LightSeaGreen" | "CadetBlue" | "DarkCyan" | "Teal" | "LightSteelBlue" | "PowderBlue" | "LightBlue" | "SkyBlue" | "LightSkyBlue" | "DeepSkyBlue" | "DodgerBlue" | "CornflowerBlue" | "SteelBlue" | "RoyalBlue" | "Blue" | "MediumBlue" | "DarkBlue" | "Navy" | "MidnightBlue" | "Lavender" | "Thistle" | "Plum" | "Violet" | "Orchid" | "Fuchsia" | "Magenta" | "MediumOrchid" | "MediumPurple" | "BlueViolet" | "DarkViolet" | "DarkOrchid" | "DarkMagenta" | "Purple" | "Indigo" | "DarkSlateBlue" | "RebeccaPurple" | "SlateBlue" | "MediumSlateBlue"; /** * | key | description | * | :-------------- | :-------------- | * | Arial | Arial | * | Arial Black | Arial Black | * | Comic Sans MS | Comic Sans MS | * | Courier New | Courier New | * | Geneva | Geneva | * | Georgia | Georgia | * | Helvetica | Helvetica | * | Impact | Impact | * | Lucida Console | Lucida Console | * | Meiryo | Meiryo | * | Meiryo UI | Meiryo UI | * | MingLiU | MingLiU | * | MingLiU-ExtB | MingLiU-ExtB | * | MS Gothic | MS Gothic | * | MS Mincho | MS Mincho | * | MS PGothic | MS PGothic | * | MS PMincho | MS PMincho | * | MS Song | MS Song | * | MS UI Gothic | MS UI Gothic | * | NSimSun | NSimSun | * | Osaka | Osaka | * | PMingLiU | PMingLiU | * | PMingLiU-ExtB | PMingLiU-ExtB | * | SimSun | SimSun | * | SimSun-ExtB | SimSun-ExtB | * | Song | Song | * | Tahoma | Tahoma | * | Times New Roman | Times New Roman | * | Trebuchet MS | Trebuchet MS | * | Verdana | Verdana | * | Yu Gothic | Yu Gothic | */ export type ExportSettingsWatermarkFontFamily = "Arial" | "Arial Black" | "Comic Sans MS" | "Courier New" | "Geneva" | "Georgia" | "Helvetica" | "Impact" | "Lucida Console" | "Meiryo" | "Meiryo UI" | "MingLiU" | "MingLiU-ExtB" | "MS Gothic" | "MS Mincho" | "MS PGothic" | "MS PMincho" | "MS Song" | "MS UI Gothic" | "NSimSun" | "Osaka" | "PMingLiU" | "PMingLiU-ExtB" | "SimSun" | "SimSun-ExtB" | "Song" | "Tahoma" | "Times New Roman" | "Trebuchet MS" | "Verdana" | "Yu Gothic"; /** * | key | description | * | :----- | :------- | * | Pdf12 | PDF-1.2 | * | Pdf13 | PDF-1.3 | * | Pdf14 | PDF-1.4 | * | Pdf15 | PDF-1.5 | * | Pdf16 | PDF-1.6 | * | Pdf17 | PDF-1.7 | * | Pdf20 | PDF-2.0 | * | PdfA1a | PDF/A-1a | * | PdfA1b | PDF/A-1b | * | PdfA2a | PDF/A-2a | * | PdfA2b | PDF/A-2b | * | PdfA2u | PDF/A-2u | * | PdfA3a | PDF/A-3a | * | PdfA3b | PDF/A-3b | * | PdfA3u | PDF/A-3u | * | PdfUA1 | PDF/UA-1 | */ export type ExportSettingsPdfVersion = "Pdf12" | "Pdf13" | "Pdf14" | "Pdf15" | "Pdf16" | "Pdf17" | "Pdf20" | "PdfA1a" | "PdfA1b" | "PdfA2a" | "PdfA2b" | "PdfA2u" | "PdfA3a" | "PdfA3b" | "PdfA3u" | "PdfUA1"; /** * | key | description | * | :------ | :------ | * | Partial | Partial | * | All | All | * | None | None | */ export type ExportSettingsPdfEmbedFonts = "Partial" | "All" | "None"; /** * | key | description | * | :--------- | :--------- | * | None | None | * | Outlines | Outlines | * | Thumbs | Thumbs | * | FullScreen | FullScreen | */ export type ExportSettingsPdfDisplayMode = "None" | "Outlines" | "Thumbs" | "FullScreen"; /** * | key | description | * | :------------------ | :--------------------- | * | Simplex | Simplex | * | DuplexFlipLongEdge | Duplex Flip Long Edge | * | DuplexFlipShortEdge | Duplex Flip Short Edge | */ export type ExportSettingsPdfDuplexMode = "Simplex" | "DuplexFlipLongEdge" | "DuplexFlipShortEdge"; /** * | key | description | * | :--------------------- | :-------------------------- | * | None | None | * | AllowPrint | Allow To Print | * | AllowModifyContents | Allow To Modify Contents | * | AllowCopy | Allow To Copy | * | AllowModifyAnnotations | Allow To Modify Annotations | * | AllowFillIn | Allow To Fill In | * | AllowAccessibleReaders | Allow Accessible Readers | * | AllowAssembly | Allow Assembly | * | Default | Default | */ export type ExportSettingsPdfPermissions = "None" | "AllowPrint" | "AllowModifyContents" | "AllowCopy" | "AllowModifyAnnotations" | "AllowFillIn" | "AllowAccessibleReaders" | "AllowAssembly" | "Default"; /** * | key | description | * | :--- | :--- | * | Xlsx | Xlsx | * | Xls | Xls | */ export type ExportSettingsExcelFileFormat = "Xlsx" | "Xls"; /** * | key | description | * | :----------- | :----------- | * | Transitional | Transitional | * | Strict | Strict | */ export type ExportSettingsExcelOutputFormat = "Transitional" | "Strict"; /** * | key | description | * | :-------------- | :---------------- | * | SingleSheet | Single Sheet | * | SectionPerSheet | Section Per Sheet | * | PagePerSheet | Page Per Sheet | */ export type ExportSettingsExcelSheetMode = "SingleSheet" | "SectionPerSheet" | "PagePerSheet"; /** * | key | description | * | :--- | :--- | * | Xlsx | Xlsx | * | Csv | Csv | */ export type ExportSettingsExceldataFileFormat = "Xlsx" | "Csv"; /** * | key | description | * | :------- | :-------- | * | Word2007 | Word 2007 | * | Word2010 | Word 2010 | * | Word2013 | Word 2013 | */ export type ExportSettingsDocxDocumentCompatibilityVersion = "Word2007" | "Word2010" | "Word2013"; /** * | key | description | * | :---- | :---- | * | Auto | Auto | * | True | True | * | False | False | */ export type ExportSettingsDocxFontEmbeddingMode = "Auto" | "True" | "False"; /** * | key | description | * | :-- | :--- | * | csv | .csv | * | txt | .txt | */ export type ExportSettingsCsvExtension = "csv" | "txt"; /** * | key | description | * | :-------- | :-------- | * | Galley | Galley | * | Paginated | Paginated | */ export type ExportSettingsHtmlRenderMode = "Galley" | "Paginated"; /** * | key | description | * | :---- | :---- | * | Html | Html | * | Mixed | Mixed | */ export type ExportSettingsHtmlRenderingEngine = "Html" | "Mixed"; /** * | key | description | * | :--- | :--- | * | Png | PNG | * | Jpeg | JPEG | * | Gif | GIF | * | Bmp | BMP | * | Tiff | TIFF | */ export type ExportSettingsImageType = "Png" | "Jpeg" | "Gif" | "Bmp" | "Tiff"; /** * | key | description | * | :----- | :----- | * | None | None | * | Rle | Rle | * | Ccitt3 | Ccitt3 | * | Lzw | Lzw | */ export type ExportSettingsImageCompression = "None" | "Rle" | "Ccitt3" | "Lzw"; /** * | key | description | * | :----- | :----- | * | Adjust | Adjust | * | Remove | Remove | * | Keep | Keep | */ export type ExportSettingsTxtHorizontalPaddings = "Adjust" | "Remove" | "Keep"; /** @deprecated This type will be removed in future releases, use ExportSettingsPdfVersion instead */ export type ExportSettingsVersion = ExportSettingsPdfVersion; /** @deprecated This type will be removed in future releases, use ExportSettingsPdfEmbedFonts instead */ export type ExportSettingsEmbedFonts = ExportSettingsPdfEmbedFonts; /** @deprecated This type will be removed in future releases, use ExportSettingsPdfDisplayMode instead */ export type ExportSettingsDisplayMode = ExportSettingsPdfDisplayMode; /** @deprecated This type will be removed in future releases, use ExportSettingsPdfDuplexMode instead */ export type ExportSettingsDuplexMode = ExportSettingsPdfDuplexMode; /** @deprecated This type will be removed in future releases, use ExportSettingsPdfPermissions instead */ export type ExportSettingsPermissions = ExportSettingsPdfPermissions; /** @deprecated This type will be removed in future releases, use ExportSettingsExcelFileFormat instead */ export type ExportSettingsFileFormat = ExportSettingsExcelFileFormat; /** @deprecated This type will be removed in future releases, use ExportSettingsExcelOutputFormat instead */ export type ExportSettingsOutputFormat = ExportSettingsExcelOutputFormat; /** @deprecated This type will be removed in future releases, use ExportSettingsDocxDocumentCompatibilityVersion instead */ export type ExportSettingsDocumentCompatibilityVersion = ExportSettingsDocxDocumentCompatibilityVersion; /** @deprecated This type will be removed in future releases, use ExportSettingsCsvExtension instead */ export type ExportSettingsExtension = ExportSettingsCsvExtension; /** @deprecated This type will be removed in future releases, use ExportSettingsHtmlRenderMode instead */ export type ExportSettingsRenderMode = ExportSettingsHtmlRenderMode; /** @deprecated This type will be removed in future releases, use ExportSettingsHtmlRenderingEngine instead */ export type ExportSettingsRenderingEngine = ExportSettingsHtmlRenderingEngine; /** @deprecated This type will be removed in future releases, use ExportSettingsTxtHorizontalPaddings instead */ export type ExportSettingsHorizontalPaddings = ExportSettingsTxtHorizontalPaddings; export type ExportSettingsPdf = { Version?: ExportSettingsPdfVersion; EmbedFonts?: ExportSettingsPdfEmbedFonts; NeverEmbedFonts?: string; PrintOnOpen?: boolean; Title?: string; Author?: string; Subject?: string; Keywords?: string; Application?: string; Use128Bit?: boolean; HideToolbar?: boolean; HideMenubar?: boolean; HideWindowUI?: boolean; FitWindow?: boolean; CenterWindow?: boolean; DisplayTitle?: boolean; DisplayMode?: ExportSettingsPdfDisplayMode; DuplexMode?: ExportSettingsPdfDuplexMode; NumberOfCopies?: number; PaperSourceByPageSize?: boolean; PrintPageRange?: string; IsPaginated?: boolean; PrintLayoutMode?: ExportSettingsPrintLayoutMode; SizeToFit?: boolean; StartPage?: number; EndPage?: number; WatermarkAngle?: number; WatermarkColor?: ExportSettingsWatermarkColor; WatermarkTitle?: string; WatermarkFontFamily?: ExportSettingsWatermarkFontFamily; WatermarkFontSize?: number; WatermarkFontBold?: boolean; WatermarkFontItalic?: boolean; WatermarkFontStrikeout?: boolean; WatermarkFontUnderline?: boolean; Encrypt?: boolean; OwnerPassword?: string; UserPassword?: string; Permissions?: ExportSettingsPdfPermissions; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsExcel = { Title?: string; Author?: string; Categories?: string; UseCompression?: boolean; FileFormat?: ExportSettingsExcelFileFormat; OutputFormat?: ExportSettingsExcelOutputFormat; EnableToggles?: boolean; Pagination?: boolean; UseDefaultPalette?: boolean; SheetMode?: ExportSettingsExcelSheetMode; SheetName?: string; ProtectedBy?: string; WritePassword?: string; Password?: string; ReadOnlyRecommended?: boolean; Orientation?: ExportSettingsOrientation; PaperSize?: ExportSettingsPaperSize; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsExceldata = { FileFormat?: ExportSettingsExceldataFileFormat; Title?: string; Author?: string; Categories?: string; OpenXmlStandard?: ExportSettingsOpenXmlStandard; UseCompression?: boolean; RightToLeft?: boolean; AllowImages?: boolean; AutoRowsHeight?: boolean; Encoding?: ExportSettingsEncoding; NoHeader?: boolean; ColumnsDelimiter?: string; RowsDelimiter?: string; QuotationSymbol?: string; DateTimeFormat?: string; NumericFormat?: string; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsDocx = { Title?: string; Author?: string; Categories?: string; DpiX?: number; DpiY?: number; DocumentCompatibilityVersion?: ExportSettingsDocxDocumentCompatibilityVersion; FontEmbeddingMode?: ExportSettingsDocxFontEmbeddingMode; TOCAutoUpdate?: boolean; CompanyName?: string; WritePassword?: string; Password?: string; ReadOnlyRecommended?: boolean; Orientation?: ExportSettingsOrientation; PaperSize?: ExportSettingsPaperSize; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsCsv = { Encoding?: ExportSettingsEncoding; NoHeader?: boolean; ColumnsDelimiter?: string; RowsDelimiter?: string; QuotationSymbol?: string; Extension?: ExportSettingsCsvExtension; DateTimeFormat?: string; NumericFormat?: string; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsHtml = { EmbedImages?: boolean; Fragment?: boolean; StyleStream?: boolean; OutputTOC?: boolean; RenderMode?: ExportSettingsHtmlRenderMode; RenderingEngine?: ExportSettingsHtmlRenderingEngine; LinkTarget?: string; EndPage?: number; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsImage = { ImageType?: ExportSettingsImageType; Pagination?: boolean; Compression?: ExportSettingsImageCompression; DpiX?: number; DpiY?: number; Quality?: number; Dither?: boolean; PrintLayoutMode?: ExportSettingsPrintLayoutMode; SizeToFit?: boolean; StartPage?: number; EndPage?: number; WatermarkAngle?: number; WatermarkColor?: ExportSettingsWatermarkColor; WatermarkTitle?: string; WatermarkFontFamily?: ExportSettingsWatermarkFontFamily; WatermarkFontSize?: number; WatermarkFontBold?: boolean; WatermarkFontItalic?: boolean; WatermarkFontStrikeout?: boolean; WatermarkFontUnderline?: boolean; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsJson = { Formatted?: boolean; QuotePropertyNames?: boolean; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsTxt = { CharWidthInTwips?: number; CharHeightInTwips?: number; HorizontalPaddings?: ExportSettingsTxtHorizontalPaddings; LineEnding?: string; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsXml = { Formatted?: boolean; WriteEmptyAttributes?: boolean; DefaultDateFormat?: string; FilenameTemplate?: string; AddTimestamp?: boolean; }; export type ExportSettingsMap = { pdf: ExportSettingsPdf; excel: ExportSettingsExcel; exceldata: ExportSettingsExceldata; docx: ExportSettingsDocx; csv: ExportSettingsCsv; html: ExportSettingsHtml; image: ExportSettingsImage; json: ExportSettingsJson; txt: ExportSettingsTxt; xml: ExportSettingsXml; }; /** All supported exports. */ export type ExportType = "pdf" | "excel" | "exceldata" | "docx" | "csv" | "html" | "image" | "json" | "txt" | "xml"; export type ExportSettings = ExportSettingsMap[T]; declare const ALL_CUSTOM_TOGGLE_ICONS_PAIRS_KEYS: readonly [ "plusMinus", "plusMinusBoxOutline", "rightBottomChevronsCircleOutline", "rightBottomDoubleChevrons", "rightBottomTriangles", "rightBottomChevrons" ]; export type CustomToggleIconsPairKey = typeof ALL_CUSTOM_TOGGLE_ICONS_PAIRS_KEYS[number]; export type CustomToggleIconsOptions = { iconsPairKey: "$default"; } | { iconsPairKey: CustomToggleIconsPairKey; fillColor?: string; lineColor?: string; }; export type FontIcon = { /** Icon type */ type: "font"; /** CSS class name */ iconCssClass: string; /** Icon font size */ fontSize?: string; }; export type CssIcon = { /** Icon type */ type: "css"; /** CSS class name */ cssClass: string; }; declare const ALL_DISPLAY_TYPES: readonly [ "Page", "Galley" ]; /** All supported display types. */ export type DisplayType = typeof ALL_DISPLAY_TYPES[number]; declare const ALL_ZOOM_MODES: readonly [ "Default", "FitToPage", "FitToWidth" ]; /** All supported zoom modes. */ export type ZoomMode = typeof ALL_ZOOM_MODES[number]; declare const ALL_VIEW_MODES: readonly [ "Single", "Continuous" ]; /** All supported view modes. */ export type ViewMode = typeof ALL_VIEW_MODES[number]; /** Generic to create a type from another type with all keys and nested keys set to optional.*/ export type PartialDeep = { [attr in keyof K]?: K[attr] extends object ? PartialDeep : K[attr]; }; /** Describes hyperlink text color options. */ export type HyperlinkOptions = { /** * Specifies the hyperlink text color on urls, bookmarks and reports.\ * Default value: '#0000ff'.\ * '$theme' - hyperlink text color is used from theme hyperlink text color.\ * '$none' - hyperlink text color remains unchanged.\ * 'LightGray'|'#6495ed'|... - hyperlink text color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * textColor: '#0000ee' */ textColor?: string; /** * Specifies the visited hyperlink text color on urls, bookmarks and reports.\ * Default value: '#800080'.\ * '$theme' - visited hyperlink text color is used from theme hyperlink text color.\ * '$none' - visited hyperlink text color remains unchanged.\ * 'LightGray'|'#6495ed'|... - visited hyperlink text color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * visitedTextColor: '#551a8b' */ visitedTextColor?: string; /** * Specifies the hovered hyperlink text color on urls, bookmarks and reports.\ * Default value: '#0000cc'.\ * '$theme' - hovered hyperlink text color is used from theme hyperlink text color.\ * '$none' - hovered hyperlink text color remains unchanged.\ * 'LightGray'|'#6495ed'|... - hovered hyperlink text color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * hoveredTextColor: '#5f5fee' */ hoveredTextColor?: string; }; declare const VIEWER_STATUSES: readonly [ "Empty", "Loading", "Cancelled", "Ready", "Failed" ]; export type ViewerStatus = typeof VIEWER_STATUSES[number]; /** All supported parameter panel show modes */ export type ParamPanelShowMode = "Default" | "Always"; /** All supported panel locations */ export type PanelsLocation = "Top" | "Right"; /** * | Key | Description | * | :-------------- | :------------------------------------------------------- | * | $print | 'Print' button. | */ export type OverridableToolbarButton = "$print"; /** * | Key | Description | * | :-------------- | :------------------------------------------------------- | * | $split | Toolbar items splitter. | * | $navigation | Pages navigation buttons group. | * | $refresh | Refresh report. | * | $refreshcache | Refresh report from cache. | * | $history | 'Go back', 'Go forward', 'Back to parent' buttons group. | * | $mousemode | Move tool button. | * | $zoom | Zoom controls group. | * | $fullscreen | Fullscreen switcher button. | * | $print | Print report. | * | $email | Email export panel. | * | $singlepagemode | Single page mode switcher button. | * | $continuousmode | Continuous mode switcher button. | * | $galleymode | Galley mode switcher button. | * | $variants | Report data variants. | * | $thumbnail | Generate thumbnail. | */ export type ToolbarButton = ("$split" | "$navigation" | "$refresh" | "$refreshcache" | "$history" | "$mousemode" | "$zoom" | "$fullscreen" | "$print" | "$email" | "$singlepagemode" | "$continuousmode" | "$galleymode" | "$variants" | "$thumbnail"); /** Represents the event arguments for Viewer state changes. */ export type OnUpdateArgs = { /** Zoom mode */ zoomMode: SetZoomModeValue; /** View mode */ viewMode: SetViewModeValue; /** A flag specifying whether the fullscreen mode is enabled. */ isFullscreen: boolean; /** * A flag specifying whether the screen is narrow.\ * Note: The screen is considered narrow if the Viewer element client width is 768 pixels or less.\ */ isNarrowScreen: boolean; /** A flag specifying whether the toolbar is visible. */ isToolbarVisible: boolean; /** A flag specifying whether the sidebar is visible. */ isSidebarVisible: boolean; /** * Viewer operational state.\ * `Empty` - Viewer is idle and contains no document.\ * `Loading` - Viewer is loading or rendering a document.\ * `Cancelled` - The loading operation was canceled.\ * `Ready` - The document is loaded and ready for interaction.\ * `Failed` - The document failed to load. */ viewerStatus: ViewerStatus; /** The pages count of the document. */ pageCount: number; /** * The current page index.\ * Note: This is not the page number; pageNumber = pageIndex + 1.\ */ pageIndex: number; }; /** The toolbar custom button icon type. */ export type Icon = FontIcon | CssIcon; /** The base properties of the CustomToolbarButton type. */ export type CustomToolbarButtonBase = { /** Unique button key */ key: string; /** Button title */ text?: string; /** Button tooltip. Default value: 'text' property value. */ title?: string; /** Icon to render on button */ icon?: Icon; /** Specifies whether button is interactive. Default value: true. */ enabled?: boolean; /** Specifies whether button is checked. If true button background is default else it is transparent. Default value: false. */ checked?: boolean; }; /** Describes the custom toolbar button type. */ export type CustomToolbarButton = CustomToolbarButtonBase & { /** Function that is invoked on `click` event. */ onClick?: (toolbarButton: CustomToolbarButtonBase) => Partial | void; /** Function that is invoked on Viewer state update event. */ onUpdate?: (args: OnUpdateArgs, toolbarButton: CustomToolbarButtonBase) => Partial | void; }; /** * Type of **success** result returned by the `Wyn.Reporting.Viewer.addToolbarButton()` or * the `Wyn.Reporting.Viewer.removeToolbarButton()` functions. */ export type ToolbarButtonOperationSuccessResult = { /** success result type */ type: "success"; }; /** * Type of **error** result returned by the `Wyn.Reporting.Viewer.addToolbarButton()` or * the `Wyn.Reporting.Viewer.removeToolbarButton()` functions. */ export type ToolbarButtonOperationErrorResult = { /** error result type */ type: "error"; error: { /** error caption */ caption: string; /** error details */ details: string; }; }; /** * Base type of result returned by the `Wyn.Reporting.Viewer.addToolbarButton()` or * the `Wyn.Reporting.Viewer.removeToolbarButton()` functions. */ export type ToolbarButtonOperationResult = ToolbarButtonOperationSuccessResult | ToolbarButtonOperationErrorResult; /** Type of result returned by the `Wyn.Reporting.Viewer.addToolbarButton()`. */ export type AddToolbarButtonResult = ToolbarButtonOperationResult; /** Type of result returned by the `Wyn.Reporting.Viewer.removeToolbarButton()`. */ export type RemoveToolbarButtonResult = ToolbarButtonOperationResult; /** Describes the parameter value used to run the report. */ export type Parameter = { /** * The name of the parameter. * @example * name: 'Parameter1' */ name: string; /** * The value(s) of the parameter. * @example * values: ['a', 'b', 'c'] */ values: any[]; }; /** Describes the open report options. */ export type OpenReportOptions = { /** The array of the report parameters values. * @example * // String parameters * parameters: [{ name: 'Country', values: ['China'] }, { name: 'Category', values: ['City'] }] * * // Float parameters * parameters: [{ name: 'myFloat', values: [23.4] }] * * // Integer parameters * parameters: [{ name: 'myInteger', values: [345] }] * * // DateTime parameters * parameters: [{ name: 'myDateTime', values: ['2020-11-13T16:47:59.000Z'] }] * * // Date parameters * parameters: [{ name: 'myDate', values: ['2020-11-13T16:47:59.000Z'] }] * * // Relative DateTime parameters * // For more information on relative datetime's format see notes below. * parameters: [{ name: 'myDateTime', values: ['@+m_e-1w+1d|01:59:59'] }] * * // Relative Date parameters * // For more information on relative date's format see notes below. * parameters: [{ name: 'myDate', values: ['@+m_e-1w+1d'] }] * * // Boolean parameters * parameters: [{ name: 'myBoolean', values: [true] }] * * // Multivalue string parameters * parameters: [{ name: 'Country', values: ['China', 'Russia'] }] * * @description * Notes on Relative Date/DateTime parameters: * * Relative dates follow this format: `@{ref}{unit}{boundary}{shifts}|{time}`. * * **ref** can be current, previous or next. `-` stands for previous, `+` stands for next, if omitted - `current` is set. * * **unit** is a date unit, that can be a day, a week, a month, a year or a quarter. **unit** part is required. * **unit** can can be one of the following: `d` - day, `w` - week, `m` - month, `y` - year, `q` - quarter. * * **boundary** can be either beginning or end. `_e` stands for end, `_b` stands for beginning. If **boundary** is ommited, then `beginning` is set. * * **shifts** allows to shift date by a certain shift value. **shifts** format is `{shiftValue}{shiftUnit}`. * **shiftValue** is a positive or negative integer number excluding 0. * **shiftUnit** can be one of the following: `d` - day, `w` - week, `m` - month, `y` - year. * **shifts** part can be ommitted. * * **time** is passed in `HH:mm:ss` format (24-hour notation with leading zeroes). **time** must be preceded with `|` separator. * Time value can be ommitted, and if it's ommitted, then time is set based on boundary: for `beginning` - 00:00:00 is set, for `end` - 23:59:59 is set. * Time is ignored for Date parameters and if `parameterPanel.relativeDateEditors.hideTime` option is set to true. * * For example, `@w_e` stands for `the end of the current week` (time is not passed, so 23:59:59 is set). * * `@-m+1d-1w` stands for `the beginning of the previous month plus 1 day minus 1 week` (time is not passed, so 00:00:00 is set). * * `@+y_e-1m|02:59:59` stands for `the end of the next year minus 1 month at 02:59:59`. */ parameters?: Parameter[]; /** The array of the report items names to be rendered from the opened report.\ * By default the whole report content is rendered if this property is `undefined`. * @example * reportItems: ['Table1', 'Chart1'], */ reportItems?: string[]; /** * Specifies the id of Time Zone a report to be rendered with. * @example * timeZoneId: 'Australia/Melbourne' */ timeZoneId?: string; /** * Specifies the variant to be applied to the report if no parameters were specified explicitly. * @example * variantId: '2f9c05c3-5214-4e24-8735-5144176e8e45' */ variantId?: string; }; /** Information on the opened report. */ export type ReportInfo = { /** The name of the report. */ name: string; /** The display type of the report. */ displayType: DisplayType; }; /** Describes the search options. */ export type SearchOptions = { /** * Specifies whether the search is case-sensitive. Default value: false. * @example * matchCase: true */ matchCase?: boolean; /** * Specifies whether the search should look for a whole phrase. Default value: false. * @example * wholePhrase: true */ wholePhrase?: boolean; }; /** Describes the search result. */ export type SearchResult = { /** The index of the page where the occurrence is found.*/ PageIndex: number; /** Text to display. */ DisplayText: string; }; /** Describes the export options. */ export type ExportOptions = { /** * Specifies the export settings available for RenderingExtensions. * @example * settings: { Title: '1997 Annual Report' } */ settings?: ExportSettings; }; /** Describes the export result. */ export type ExportResult = { /** The exported report file */ file: Blob; /** The filename of the report. */ filename?: string; }; /** Describes Page View scrollbars options on desktop devices. */ export type PageViewScrollbarsOptions = { /** * Specifies whether page view scrollbars are always visible or not.\ * If set to `true`, thumb and track `opacity` settings and `growOnHover` track setting are ignored. * Default value: `false`. * @example * alwaysVisible: true */ alwaysVisible?: boolean; /** * Specifies the page view scrollbars width in px.\ * Scrollbars width has to be greater than or equal to 4 and must not exceed 20. * @example * width: 8 */ width?: number; /** * Specifies vertical and horizontal scrollbars thumbs settings. */ thumb?: { /** * Specifies vertical and horizontal scrollbars thumbs background color.\ * Default value: '$none'.\ * '$theme' - thumb background color is used from theme background color.\ * '$none' - thumb background color remains unchanged.\ * '$none' and '$theme' colors are equal.\ * 'LightGray'|'#6495ed'|... - thumb background color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * color: 'LightGray' */ color?: string; /** * Specifies vertical or horizontal scrollbars thumb background color on hover over the thumb.\ * Default value: '$none'.\ * '$theme' - background color is used from theme background color.\ * '$none' - background color remains unchanged.\ * If `alwaysVisible` setting is enabled, '$none' and '$theme' colors are equal.\ * 'LightGray'|'#6495ed'|... - thumb background color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * colorHovered: 'LightGray' */ colorHovered?: string; /** * Specifies whether thumbs have to grow on hover. Default value: true.\ * This setting is applied only if `alwaysVisible` setting is disabled or track color fits al least one of the following conditions:\ * track color is not set;\ * track color equals to `transparent`;\ * track has opacity `0`. * @example * growOnHover: false */ growOnHover?: boolean; /** * Specifies the page view vertical and horizontal scrollbars thumbs opacity in `%`.\ * Thumbs opacity have to be greater than or equal to 10 and must not exceed 100.\ * This setting is ignored if `alwaysVisible` setting is enable.\ * Default value: 20. * @example * opacity: 50 */ opacity?: number; }; /** * Specifies vertical and horizontal scrollbars tracks settings. */ track?: { /** * Specifies vertical and horizontal scrollbars tracks background color.\ * Default value: '$none'.\ * '$theme' - track background color is used from theme background color.\ * '$none' - track background color remains unchanged.\ * If `alwaysVisible` setting is enabled, '$none' and '$theme' colors are equal.\ * 'LightGray'|'#6495ed'|... - background color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * color: 'LightGray' */ color?: string; /** * Specifies the page view vertical and horizontal scrollbars tracks opacity in `%`.\ * Tracks opacity have to be greater than or equal to 0 and must not exceed 100.\ * This setting is ignored if `alwaysVisible` setting is enable.\ * Default value: 0. * @example * opacity: 10 */ opacity?: number; }; }; /** Describes the page view options. */ export type PageViewOptions = { /** * Defines horizontal alignment for report page inside view area. Default value: 'center'. * @example * horizontalAlignment: 'left' */ horizontalAlignment?: "left" | "right" | "center"; /** * Removes 'gray' background, shadows, paper borders, and other things that make 'paper view'. Default value: false. * @example * withoutPaperView: true */ withoutPaperView?: boolean; /** * Specifies page view horizontal and vertical scrollbars settings. * @example * scrollbars: { alwaysVisible: true, width: 10, thumb: { color: '$theme' } } */ scrollbars?: PageViewScrollbarsOptions; }; /** Describes load chart animation that can be applied to the report view. */ export type LoadChartAnimationOptions = { /** * Enable load chart animation. Default value: false. * @example * enabled: true */ enabled?: boolean; }; /** Describes hover chart animation that can be applied to the report view. */ export type HoverChartAnimationOptions = { /** * Enable hover chart animation. Default value: false. * @example * enabled: true */ enabled?: boolean; }; /** Describes hover table and tablix animation that can be applied to the report view. */ export type HoverTableAnimationOptions = { /** * Enable hover table and tablix animation. Default value: false. * @example * enabled: true */ enabled?: boolean; /** * Specifies the background color on hover over the table and tablix row.\ * Default value: '$theme'.\ * '$theme' - background color is used from theme background color.\ * '$none' - background color remains unchanged.\ * 'LightGray'|'#6495ed'|... - background color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * backgroundColor: 'LightGray' */ backgroundColor?: string; /** * Specifies the text color on hover over the table and tablix row.\ * Default value: '$theme'.\ * '$theme' - text color is used from theme text color.\ * '$none' - text color remains unchanged.\ * 'LightGray'|'#6495ed'|... - text color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * textColor: 'DarkGray' */ textColor?: string; }; /** Describes all possible values for chart tooltip fontStyle option. */ export type ChartTooltipFontStyle = "Normal" | "Italic"; /** Describes all possible values for chart tooltip fontWeight option. */ export type ChartTooltipFontWeight = "Lighter" | "Thin" | "ExtraLight" | "Light" | "Normal" | "Medium" | "SemiBold" | "Bold" | "ExtraBold" | "Heavy" | "Bolder"; /** Describes all possible values for chart tooltip borderStyle option. */ export type ChartTooltipBorderStyle = "None" | "Dotted" | "Dashed" | "Solid" | "Double" | "Groove" | "Ridge" | "Inset" | "Outset"; /** Describes chart tooltip style options. */ export type ChartTooltipAnimationOptions = { /** * Enable chart tooltip.\ * If this value is set to false, the chart tooltip will not be displayed.\ * Default value: true. * @example * enabled: false */ enabled?: boolean; /** * Specifies the chart tooltip background color.\ * Default value: '#fff'.\ * '$theme' - background color is used from theme background color.\ * '$none' - background color remains unchanged.\ * 'LightGray'|'#6495ed'|... - background color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * backgroundColor: 'LightGray' */ backgroundColor?: string; /** * Specifies the chart tooltip text color.\ * Default value: '#333'.\ * '$theme' - text color is used from theme text color.\ * '$none' - text color remains unchanged.\ * 'LightGray'|'#6495ed'|... - text color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * textColor: 'DarkGray' */ textColor?: string; /** * Specifies the font family used in the chart tooltip.\ * If **fontFamily** is not specified explicitly here, the default font family is used. * @example * fontFamily: 'Times New Roman' */ fontFamily?: string; /** * Specifies the size of the font used in the chart tooltip.\ * Font size can be set in px or pt. Font size value has to be greater than 6 and must not exceed 72. * Default value: '12px'.\ * @example * fontSize: '10pt' */ fontSize?: string; /** * Specifies the font style used in the chart tooltip.\ * Default value: 'Normal'.\ * @example * fontStyle: 'Italic' */ fontStyle?: ChartTooltipFontStyle; /** * Specifies the font weight used in the chart tooltip.\ * Default value: 'Normal'.\ * @example * fontWeight: 'Bold' */ fontWeight?: ChartTooltipFontWeight; /** * Specifies the color of chart tooltip borders.\ * Default value: '#292929'.\ * '$theme' - border color is used from theme border color.\ * '$none' - border color remains unchanged.\ * 'LightGray'|'#6495ed'|... - border color is used from value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value * @example * borderColor: '#4e0000' */ borderColor?: string; /** * Specifies the size of the chart tooltip borders.\ * The value must be greater than 0 and less than 10.\ * Default value: '1px'.\ * @example * borderSize: '1pt' */ borderSize?: string; /** * Specifies the style of the chart tooltip borders.\ * Default value: 'Solid'.\ * @example * borderStyle: 'Dotted' */ borderStyle?: ChartTooltipBorderStyle; /** * Specifies the radius of the chart tooltip borders in px or pt.\ * The value must be greater or equal to 0 and less than 72.\ * Default value: '3px'.\ * @example * borderRadius: '1pt' */ borderRadius?: string; }; /** Describes animation that can be applied to the report view. */ export type AnimationOptions = { /** * Set load chart animation settings. Default value: \. * @example * loadChart: { enabled: true } */ loadChart?: LoadChartAnimationOptions; /** * Set hover chart animation settings. Default value: \. * @example * hoverChart: { enabled: true } */ hoverChart?: HoverChartAnimationOptions; /** * Set hover table and tablix animation settings. Default value: \. * @example * hoverTable: { enabled: true } */ hoverTable?: HoverTableAnimationOptions; /** * Set chart tooltip style settings. */ chartTooltip?: ChartTooltipAnimationOptions; }; /** Parameter panel's init validation modes */ export type ParameterPanelInitValidationMode = "Full" | "Fast"; /** Describes Relative Date editors options */ export type RelativeDateEditorsOptions = { /** * Enable Relative Date editor for date/date-time parameters. Default value: false. * @example * enabled: true */ enabled?: boolean; /** * A flag specifying whether to hide the date shifts editor in the Relative Date editor for date/date-time parameters. Default value: false. * @example * hideShifts: true */ hideShifts?: boolean; /** * A flag specifying whether to hide the time editor in the Relative Date editor for date-time parameters. Default value: false. * @example * hideTime: true */ hideTime?: boolean; }; /** Describes parameter panel options. */ export type ParameterPanelOptions = { /** * Set up parameters panel position. Default value: 'Right'. */ position?: PanelsLocation; /** * Set up a rule for showing parameter panel. If value is 'Always', parameter panel is shown anyway on document opening event. Default value: 'Default'. */ showMode?: ParamPanelShowMode; /** * Enables rounded corners of parameter panel's controls. Default value: false. */ roundedControls?: boolean; /** * Specifies validation mode on parameter panel's initialization. * If this option is set to 'Full' then all validation will be performed as usual. * If this option is set to 'Fast' then only basic validation of parameters will take place. This might increase Viewer opening speed significantly, however please ensure that all passed parameters values are valid. * When this option is set to 'Fast', parameter panel will be initialized with parameter's default values or values passed to Viewer on initialization (from URL, Jump To options, Viewer API, or Data Filters). This option takes effect only if **all** parameters values are defined constants. * If any of the parameters values are not set or invalid then 'Full' validation mode will be used. * Default value: 'Full'. */ initValidationMode?: ParameterPanelInitValidationMode; /** * Specifies whether to enable inline Preview button in Multivalue parameter dropdown. * If set to `true`, inline Preview button will be shown inside dropdown if any value is selected. * Default value: true. */ enableInlinePreviewButton?: boolean; /** * Specifies whether Null icon should be always shown. * If set to `false`, Null icon will be shown only on hover and when parameter value is set to Null. * Default value: false. */ alwaysShowNullIcon?: boolean; /** * Defines Relative Date editors options. * @example * relativeDateEditors: { enabled: true } */ relativeDateEditors?: RelativeDateEditorsOptions; /** * A flag specifying whether to hide the Time Zone dropdown on the Parameter Panel. Default value: false. * @example * hideTimeZone: true */ hideTimeZone?: boolean; }; /** Base notification structure */ export type BaseNotification = { /** Title or short summary of the notification */ caption: string; /** Detailed description or content of the notification */ details: string; }; /** Warning-level notification structure */ export type WarningNotification = BaseNotification; /** Error-level notification structure */ export type ErrorNotification = BaseNotification; /** * Function type to handle notification * @param notification - Notification object to be handled * @returns void */ export type NotificationHandler = (notification: T) => void; /** The base primary options of the InitViewerOptions type. */ export type InitViewerOptionsBase = { /** * A DOMString that specifies the element hosting the Viewer control. * @example * element: 'report-viewer-app' */ element: string; /** * Wyn Portal URL. * @example * portalUrl: 'https://wyn-portal.com/' */ portalUrl?: string; /** * The reference key needed to access the Wyn API. * @example * referenceToken: '' */ referenceToken?: string; /** * The reference key name used in query parameters, configured in the Wyn Config file. * If referenceTokenKey is not specified, default value is 'token'. * @example * referenceTokenKey: ''; */ referenceTokenKey?: string; /** * The id of the report to be shown by the Viewer. * @deprecated * Use * ``` * await viewer.openReport('', { parameters: [{ name: 'myString', values: ['123'] }] }); * ``` * @example * reportId: '' */ reportId?: string; /** * The array of the {name, value} pairs that describe the parameters values used to run the report. * @deprecated * Use * ``` * await viewer.openReport('', { parameters: [{ name: 'myString', values: ['123'] }] }); * ``` * @example * // String parameters * reportParameters: [{ name: 'myString', values: ['123'] }] * * // Float parameters * reportParameters: [{ name: 'myFloat', values: [23.4] }] * * // Integer parameters * reportParameters: [{ name: 'myInteger', values: [345] }] * * // DateTime parameters * reportParameters: [{ name: 'myDateTime', values: ['2020-11-13T16:47:59.000Z'] }] * * // Date parameters * reportParameters: [{ name: 'myDate', values: ['2020-11-13T16:47:59.000Z'] }] * * // Boolean parameters * reportParameters: [{ name: 'myBoolean', values: [true] }] * * // Multivalue string parameters * reportParameters: [{ name: 'Country', values: ['China', 'Russia'] }] */ reportParameters?: Parameter[]; /** * Specifies locale used for displaying Viewer. * If **locale** is not specified explicitly here, the locale corresponding to the browser preferences is used. * @example * locale: 'zh' */ locale?: string; }; /** The other secondary options of the InitViewerOptions type. */ export type InitViewerOptionsOther = { /** * Makes the Viewer display the custom title. * @param reportName report name. * @example * makeTitle: (reportName) => reportName + ' - Wyn Enterprise' */ makeTitle?: (reportName: string) => string; /** * The array of export types available via Export functionality of Viewer. By default all `ExportType` values are used. * @example * availableExports: ['xml', 'pdf'] */ availableExports?: ExportType[]; /** * The array of toolbar buttons to be available in Viewer Toolbar. The order of toolbar buttons in this array affects Viewer.\ * By default all toolbar buttons are available. Please find below all available toolbar buttons in the predefined order:\ * \ * `'$navigation', '$split', '$refresh', '$refreshcache', '$split', '$history',`\ * `'$split', '$mousemode', '$zoom', '$fullscreen', '$split', '$print', '$email',`\ * `'$singlepagemode', '$continuousmode', '$galleymode', '$variants', '$thumbnail',`\ * \ * Here `'$split'` is used to add splitters between toolbar buttons. Leading, trailing and duplicate `'$split'` entries are omitted.\ * Toolbar buttons displayed in Viewer are intersection of this option and toolbar buttons specified in commands of the previewed report. * @example * availableToolbarButtons: ['$navigation', '$split', '$refresh', '$split', '$history', '$split', '$zoom', '$fullscreen'], */ availableToolbarButtons?: ToolbarButton[]; /** * Set up display type. Default value is report display type. * @example * displayType: 'Galley' */ displayType?: DisplayType; /** * Set up single page or continuous page. Default value: 'Single'. * @example * viewMode: 'Continuous' */ viewMode?: ViewMode; /** * Set up zoom mode. Default value 'Default'. * @example * zoomMode: 'FitToWidth' */ zoomMode?: ZoomMode; /** * Set up parameters panel position. Default value: 'Right'. * @deprecated * @example * paramPanelPosition: 'Top' */ paramPanelPosition?: PanelsLocation; /** * Set up a rule for showing parameter panel. If value is 'Always', parameter panel is shown anyway on document opening event. Default value: 'Default'. * @deprecated * @example * paramPanelShowMode: 'Always' */ paramPanelShowMode?: ParamPanelShowMode; /** * A flag specifying whether to hide the toolbars. Default value: false. * @example * hideToolbar: true */ hideToolbar?: boolean; /** * A flag specifying whether to hide the search panel. Default value: false. * @example * hideSearch: true */ hideSearch?: boolean; /** * A flag specifying whether to hide the Breadcrumbs panel. Default value: false. * @example * hideBreadcrumbs: true */ hideBreadcrumbs?: boolean; /** * A flag specifying whether to hide the Table of Contents panel. Default value: false. * @example * hideTableOfContents: true */ hideTableOfContents?: boolean; /** * Defines toolbar size. Default value: 'large'. * @example * toolbarSize: 'small' */ toolbarSize?: "small" | "medium" | "large"; /** * Disables focus highlighting timer for better accessibility. * @example * disableFocusTimer: false */ disableFocusTimer?: boolean; /** * Defines horizontal alignment, scrollbars settings and view for report page like part of the WebPage or 'paper view' * @example * pageViewOptions: { horizontalAlignment: 'right', withoutPaperView: true } */ pageViewOptions?: PageViewOptions; /** * The report view animation options. Default value: \. * @example * animation: { hoverTable: { enabled: true } } */ animation?: AnimationOptions; /** * Defines hyperlink text color settings. * @example * hyperlink: { textColor: '#0000ee', visitedTextColor: '#551a8b', hoveredTextColor: '#5f5fee' } */ hyperlink?: HyperlinkOptions; /** * Defines parameter panel options. * @example * parameterPanel: { position: 'Right', showMode: 'Always', roundedControls: true, enableInlinePreviewButton: false, alwaysShowNullIcon: true } */ parameterPanel?: ParameterPanelOptions; /** * A flag specifying whether to enable fullscreen mode.\ * Default value: fullscreen mode value specified in the opened report. * @example * isFullscreen: true */ isFullscreen?: boolean; /** * Set up report variants options. * @example * variants: { enableDefaultVariant: false } */ variants?: { /** * A flag specifying whether to enable the default variant feature for reports.\ * Default variant is applied when report is opened if no *variantId* or *parameters* passed via *OpenReportOptions*.\ * Default value: true. * @example * enableDefaultVariant: false */ enableDefaultVariant?: boolean; }; /** * Custom warning notifications handler. * If `undefined` (or not provided): keeps the default warnings handling. * If provided as a function: overrides the default warnings handling. * If `null`: explicitly suppresses warning notifications (they are not shown). * @example * onWarning: (warning) => { * console.warn(`Warning: ${warning.caption} - ${warning.details}`); * }; */ onWarning?: NotificationHandler | null; /** * Custom error notifications handler. * If `undefined` (or not provided): keeps the default errors handling. * If provided as a function: overrides the default errors handling. * If `null`: explicitly suppresses errors notifications (they are not shown). * @example * onError: (error) => { * console.error(`Error: ${error.caption} - ${error.details}`); * }; */ onError?: NotificationHandler | null; /** * If defined, this option overrides custom toggle icons specified on the report level. * @example * customToggleIcons: { * iconsPairKey: 'plusMinusBoxOutline', * fillColor: 'Lime', * lineColor: 'Teal', * } */ customToggleIcons?: CustomToggleIconsOptions; }; /** This type is derived from InitViewerOptionsOther but all its properties are recursively optional. */ export type PartialDeepViewerOptionsOther = PartialDeep; /** The following options can be set during initialization or at runtime while working with the Viewer. */ export type InitViewerOptions = InitViewerOptionsBase & InitViewerOptionsOther; /** Event handler */ export type EventHandler = (args: TArgs) => void; /** Unregister event handler */ export type UnregisterEventHandler = () => void; /** Event listener */ export type Event = { /** * Registers a new event handler. * @param eventHandler Event handler. */ readonly register: (eventHandler: EventHandler) => UnregisterEventHandler; }; /** The `reportRendered` event args. */ export type ReportRenderedEventArgs = { /** Report id */ reportId: string; /** Number of rendered report pages */ totalPages: number; /** * Tells whether report rendering was cancelled.\ * If the value is `false` or `undefined`, it means the report was fully rendered. */ cancelled?: boolean; }; export type SetZoomModeValue = number | "FitToWidth" | "FitToPage"; export type SetViewModeValue = ViewMode | "Galley"; export type BreadcrumbsNavigationDirection = "start" | "end" | "prev" | "next"; /** Type representing a Viewer instance.*/ export type Viewer = { /** * Opens report. * @param reportId The id of the report. * @param options Open report options. * @example * const reportInfo = await viewer.openReport('', { parameters: [{ name: 'myString', values: ['123'] }] }); * console.log('The report ' + reportInfo.name + ' was successfully loaded!') */ readonly openReport: (reportId: string, options?: OpenReportOptions) => Promise; /** * Refreshes the report preview. * @example * viewer.refresh(); */ readonly refresh: () => void; /** * Gets the page count of the currently displayed report. * @returns An integer representing page count. * @example * const pageCount = viewer.getPageCount(); * console.log(pageCount); */ readonly getPageCount: () => number; /** * Gets the currently displayed page number. * @returns An integer representing currently displayed page number. * @example * const currentPage = viewer.getCurrentPage(); * console.log(currentPage); */ readonly getCurrentPage: () => number; /** * Makes the viewer to display the specific page. Page numbering starts with 1. * @param pageNumber The number of pages to go to. * @example * viewer.goToPage(1); */ readonly goToPage: (pageNumber: number) => void; /** * Makes the viewer to display the parent report of the drill-down report. * @example * viewer.backToParent(); */ readonly backToParent: () => void; /** * Navigates to the root report. * @example * viewer.backToRoot(); */ readonly backToRoot: () => void; /** * Navigates to the report with specific reportId in breadcrumbs history. * If there are several reports with this reportId in breadcrumbs history, by default the first matching report will be opened. * @param reportId The id of the report. * @param dir Optional argument that specifies the direction in which history is navigated regarding to the current history position. * @returns false if passed reportId is not in breadcrumbs history, overwise returns true. * @example * viewer.goToBreadcrumbsReport('', 'end'); */ readonly goToBreadcrumbsReport: (reportId: string, dir?: BreadcrumbsNavigationDirection) => boolean; /** * Exports the currently displayed report. * @param exportType Specifies export type. * @param options Export options. * @example * await viewer.export('pdf', { settings: { Title: '1997 Annual Report' } }); */ readonly export: (exportType: T, options?: ExportOptions) => Promise; /** * Prints the currently displayed report if any. * @example * await viewer.print(); */ readonly print: () => Promise; /** * Performs the search of a specific term with specific search options. * @param searchTerm String to search for. * @param options Search options. * @returns Search result. * @example * const searchResult = await viewer.search('a', { matchCase: true, wholePhrase: false }); * console.log(searchResult); */ readonly search: (searchTerm: string, options?: SearchOptions) => Promise; /** * Sets zoom mode. * @param value Zoom mode. * @example * // Set zoom mode to 'FitToPage' * viewer.setZoomMode('FitToPage'); * * // Zoom mode can be specified as a factor. Valid values are from this interval: [0.25, 3] * viewer.setZoomMode(1.2); */ readonly setZoomMode: (value: SetZoomModeValue) => void; /** * Sets view mode. * @param value View mode. * @example * viewer.setViewMode('Galley'); */ readonly setViewMode: (value: SetViewModeValue) => void; /** * Sets or toggles fullscreen mode. * @example * // Enable fullscreen mode * viewer.toggleFullscreen(true); * * // Disable fullscreen mode * viewer.toggleFullscreen(false); * * // Toggle fullscreen mode * viewer.toggleFullscreen(); */ readonly toggleFullscreen: (enable?: boolean) => void; /** * Sets or toggles sidebar's panels visibility. * @example * // Show panel * viewer.toggleSidebar(true); * * // Hide panel * viewer.toggleSidebar(false); * * // Toggle visibility * viewer.toggleSidebar(); */ readonly toggleSidebar: (show?: boolean) => void; /** * Customize toolbar action. * @example * viewer.overrideToolbarAction('$print', () => { console.log('Print'); }) */ overrideToolbarAction: (toolbarButton: OverridableToolbarButton, action: () => void) => void; /** * Adds custom toolbar button. * @example * const pdfExportButton: CustomToolbarButton = { * key: '$pdfExport', * text: 'Export to PDF', * enabled: false, * checked: false, * icon: { type: 'font', iconCssClass: 'mdi mdi-file-pdf' }, * onClick: () => { * console.log('Exporting report to PDF...'); * // Logic for exporting report to PDF * }, * onUpdate: (args) => { * console.log('Viewer state is changed'), * // Logic for dynamically updating button state based on Viewer state * const { pageCount } = args.state.session; * return { enabled: pageCount > 0 }; * }; * }; * const result = viewer.addToolbarButton(pdfExportButton); * if (result.type === 'error') console.log(`${result.error.caption}: ${result.error.details}`); */ addToolbarButton: (toolbarButton: CustomToolbarButton) => AddToolbarButtonResult; /** * Removes toolbar button. * @example * const result = viewer.removeToolbarButton('$pdf'); * if (result.type === 'error') console.log(`${result.error.caption}: ${result.error.details}`); */ removeToolbarButton: (key: string) => RemoveToolbarButtonResult; /** * Gets available toolbar items keys. * @example * viewer.getAvailableToolbarItemsKeys(); */ getAvailableToolbarItemsKeys: () => string[]; /** * Removes the Viewer content from the element. * @example * viewer.destroy(); */ readonly destroy: () => void; /** * Set and register `reportRendered` event which occurs once document is fully rendered. * @example * const unregister = viewer.onReportRendered().register((args) => { console.log('Report was rendered!', args); }); * // It is possible to unregister this event handler when it is not needed anymore. * unregister(); */ readonly onReportRendered: () => Event; }; /** Type of the `GetLocalizationResourcesSuccessResult.resourceBundles` array element. */ export type LocalizationResourceBundle = { /** bundle namespace */ ns: string; /** localization resources */ resources: Record; }; /** Type of **success** result returned by the `Wyn.Reporting.Viewer.addLocalization()` function. */ export type AddLocalizationSuccessResult = { /** success result type */ type: "success"; }; /** Type of **error** result returned by the `Wyn.Reporting.Viewer.addLocalization()` function. */ export type AddLocalizationErrorResult = { /** error result type */ type: "error"; /** error caption */ errorCaption: string; /** error details */ errorDetails: string[]; }; /** Type of result returned by the `Wyn.Reporting.Viewer.addLocalization()` function. */ export type AddLocalizationResult = AddLocalizationSuccessResult | AddLocalizationErrorResult; /** Type of **success** result returned by the `Wyn.Reporting.Viewer.getLocalizationResources()` function. */ export type GetLocalizationResourcesSuccessResult = { /** success result type */ type: "success"; /** localization resource bundles */ resourceBundles: LocalizationResourceBundle[] | undefined; }; /** Type of **error** result returned by the `Wyn.Reporting.Viewer.getLocalizationResources()` function. */ export type GetLocalizationResourcesErrorResult = { /** error result type */ type: "error"; /** error caption */ errorCaption: string; /** error details */ errorDetails: string[]; }; /** Type of result returned by the `Wyn.Reporting.Viewer.getLocalizationResources()` function. */ export type GetLocalizationResourcesResult = GetLocalizationResourcesSuccessResult | GetLocalizationResourcesErrorResult; /** Type of the `Wyn.Reporting.Viewer` object. */ export type ViewerApi = { /** * Creates and initializes Viewer. * @param options Initialization options. * @returns Viewer instance. * @example * const viewer = Wyn.Reporting.Viewer.create({ * element: 'report-viewer-app', * portalUrl: 'http://wyn-portal.com/', * referenceToken: '', * reportId: '', * }); */ create: (options: InitViewerOptions) => Viewer; /** * Adds custom localization resources for Report Viewer.\ * Then it is required to pass `lng` to `initViewerOptions.locale` to apply added resources. * @param lng language code * @param resourceBundles LocalizationResourceBundle[] * @example * const result = Wyn.Reporting.Viewer.addLocalization('zh-CN', resourceBundles); * if (result.type === 'success') initViewerOptions.locale = 'zh-CN'; * else console.error([result.errorCaption, ...result.errorDetails].join('\n')); */ addLocalization: (lng: string, resourceBundles: LocalizationResourceBundle[]) => AddLocalizationResult; /** * Gets custom localization resources provided by the Wyn API.\ * Obtained resources are intended for `Wyn.Reporting.Viewer.addLocalization()`. * @param lng language code * @param portalUrl Wyn Portal URL. * @param referenceToken The reference key needed to access the Wyn API. * @example * const result = await Wyn.Reporting.Viewer.getLocalizationResources('zh-CN', '', ''); * if (result.type === 'success') Wyn.Reporting.Viewer.addLocalization('zh-CN', result.resourceBundles); * else console.error([result.errorCaption, ...result.errorDetails].join('\n')); */ getLocalizationResources: (lng: string, portalUrl: string, referenceToken?: string) => Promise; }; export {};