diff --git a/master/.nojekyll b/master/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/master/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/master/assets/css/main.css b/master/assets/css/main.css new file mode 100644 index 000000000..01cd747da --- /dev/null +++ b/master/assets/css/main.css @@ -0,0 +1,2632 @@ +/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ +/* ========================================================================== + * * HTML5 display definitions + * * ========================================================================== */ +/** + * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { + display: block; +} + +/** + * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ +audio, canvas, video { + display: inline-block; + *display: inline; + *zoom: 1; +} + +/** + * * Prevent modern browsers from displaying `audio` without controls. + * * Remove excess height in iOS 5 devices. */ +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. + * * Known issue: no IE 6 support. */ +[hidden] { + display: none; +} + +/* ========================================================================== + * * Base + * * ========================================================================== */ +/** + * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using + * * `em` units. + * * 2. Prevent iOS text size adjust after orientation change, without disabling + * * user zoom. */ +html { + font-size: 100%; + /* 1 */ + -ms-text-size-adjust: 100%; + /* 2 */ + -webkit-text-size-adjust: 100%; + /* 2 */ + font-family: sans-serif; +} + +/** + * * Address `font-family` inconsistency between `textarea` and other form + * * elements. */ +button, input, select, textarea { + font-family: sans-serif; +} + +/** + * * Address margins handled incorrectly in IE 6/7. */ +body { + margin: 0; +} + +/* ========================================================================== + * * Links + * * ========================================================================== */ +/** + * * Address `outline` inconsistency between Chrome and other browsers. */ +a:focus { + outline: thin dotted; +} +a:active, a:hover { + outline: 0; +} + +/** + * * Improve readability when focused and also mouse hovered in all browsers. */ +/* ========================================================================== + * * Typography + * * ========================================================================== */ +/** + * * Address font sizes and margins set differently in IE 6/7. + * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, + * * and Chrome. */ +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, .tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +/** + * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ +b, strong { + font-weight: bold; +} + +blockquote { + margin: 1em 40px; +} + +/** + * * Address styling not present in Safari 5 and Chrome. */ +dfn { + font-style: italic; +} + +/** + * * Address differences between Firefox and other browsers. + * * Known issue: no IE 6/7 normalization. */ +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * * Address styling not present in IE 6/7/8/9. */ +mark { + background: #ff0; + color: #000; +} + +/** + * * Address margins set differently in IE 6/7. */ +p, pre { + margin: 1em 0; +} + +/** + * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ +code, kbd, pre, samp { + font-family: monospace, serif; + _font-family: "courier new", monospace; + font-size: 1em; +} + +/** + * * Improve readability of pre-formatted text in all browsers. */ +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +/** + * * Address CSS quotes not supported in IE 6/7. */ +q { + quotes: none; +} +q:before, q:after { + content: ""; + content: none; +} + +/** + * * Address `quotes` property not supported in Safari 4. */ +/** + * * Address inconsistent and variable font size in all browsers. */ +small { + font-size: 80%; +} + +/** + * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ +sub { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* ========================================================================== + * * Lists + * * ========================================================================== */ +/** + * * Address margins set differently in IE 6/7. */ +dl, menu, ol, ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +/** + * * Address paddings set differently in IE 6/7. */ +menu, ol, ul { + padding: 0 0 0 40px; +} + +/** + * * Correct list images handled incorrectly in IE 7. */ +nav ul, nav ol { + list-style: none; + list-style-image: none; +} + +/* ========================================================================== + * * Embedded content + * * ========================================================================== */ +/** + * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. + * * 2. Improve image quality when scaled in IE 7. */ +img { + border: 0; + /* 1 */ + -ms-interpolation-mode: bicubic; +} + +/* 2 */ +/** + * * Correct overflow displayed oddly in IE 9. */ +svg:not(:root) { + overflow: hidden; +} + +/* ========================================================================== + * * Figures + * * ========================================================================== */ +/** + * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ +figure, form { + margin: 0; +} + +/* ========================================================================== + * * Forms + * * ========================================================================== */ +/** + * * Correct margin displayed oddly in IE 6/7. */ +/** + * * Define consistent border, margin, and padding. */ +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * * 1. Correct color not being inherited in IE 6/7/8/9. + * * 2. Correct text not wrapping in Firefox 3. + * * 3. Correct alignment displayed oddly in IE 6/7. */ +legend { + border: 0; + /* 1 */ + padding: 0; + white-space: normal; + /* 2 */ + *margin-left: -7px; +} + +/* 3 */ +/** + * * 1. Correct font size not being inherited in all browsers. + * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, + * * and Chrome. + * * 3. Improve appearance and consistency in all browsers. */ +button, input, select, textarea { + font-size: 100%; + /* 1 */ + margin: 0; + /* 2 */ + vertical-align: baseline; + /* 3 */ + *vertical-align: middle; +} + +/* 3 */ +/** + * * Address Firefox 3+ setting `line-height` on `input` using `!important` in + * * the UA stylesheet. */ +button, input { + line-height: normal; +} + +/** + * * Address inconsistent `text-transform` inheritance for `button` and `select`. + * * All other form control elements do not inherit `text-transform` values. + * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. + * * Correct `select` style inheritance in Firefox 4+ and Opera. */ +button, select { + text-transform: none; +} + +/** + * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * * and `video` controls. + * * 2. Correct inability to style clickable `input` types in iOS. + * * 3. Improve usability and consistency of cursor style between image-type + * * `input` and others. + * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. + * * Known issue: inner spacing remains in IE 6. */ +button, html input[type=button] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +input[type=reset], input[type=submit] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +/** + * * Re-set default cursor for disabled elements. */ +button[disabled], html input[disabled] { + cursor: default; +} + +/** + * * 1. Address box sizing set to content-box in IE 8/9. + * * 2. Remove excess padding in IE 8/9. + * * 3. Remove excess padding in IE 7. + * * Known issue: excess padding remains in IE 6. */ +input { + /* 3 */ +} +input[type=checkbox], input[type=radio] { + box-sizing: border-box; + /* 1 */ + padding: 0; + /* 2 */ + *height: 13px; + /* 3 */ + *width: 13px; +} +input[type=search] { + -webkit-appearance: textfield; + /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; + /* 2 */ + box-sizing: content-box; +} +input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. + * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome + * * (include `-moz` to future-proof). */ +/** + * * Remove inner padding and search cancel button in Safari 5 and Chrome + * * on OS X. */ +/** + * * Remove inner padding and border in Firefox 3+. */ +button::-moz-focus-inner, input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * * 1. Remove default vertical scrollbar in IE 6/7/8/9. + * * 2. Improve readability and alignment in all browsers. */ +textarea { + overflow: auto; + /* 1 */ + vertical-align: top; +} + +/* 2 */ +/* ========================================================================== + * * Tables + * * ========================================================================== */ +/** + * * Remove most spacing between table cells. */ +table { + border-collapse: collapse; + border-spacing: 0; +} + +ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col > :first-child > :first-child, +.col-11 > :first-child > :first-child, +.col-10 > :first-child > :first-child, +.col-9 > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-7 > :first-child > :first-child, +.col-6 > :first-child > :first-child, +.col-5 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +.col-3 > :first-child > :first-child, +.col-2 > :first-child > :first-child, +.col-1 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col > :first-child > :first-child > :first-child, +.col-11 > :first-child > :first-child > :first-child, +.col-10 > :first-child > :first-child > :first-child, +.col-9 > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-7 > :first-child > :first-child > :first-child, +.col-6 > :first-child > :first-child > :first-child, +.col-5 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child, +.col-3 > :first-child > :first-child > :first-child, +.col-2 > :first-child > :first-child > :first-child, +.col-1 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col > :last-child > :last-child, +.col-11 > :last-child > :last-child, +.col-10 > :last-child > :last-child, +.col-9 > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-7 > :last-child > :last-child, +.col-6 > :last-child > :last-child, +.col-5 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +.col-3 > :last-child > :last-child, +.col-2 > :last-child > :last-child, +.col-1 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col > :last-child > :last-child > :last-child, +.col-11 > :last-child > :last-child > :last-child, +.col-10 > :last-child > :last-child > :last-child, +.col-9 > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-7 > :last-child > :last-child > :last-child, +.col-6 > :last-child > :last-child > :last-child, +.col-5 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child, +.col-3 > :last-child > :last-child > :last-child, +.col-2 > :last-child > :last-child > :last-child, +.col-1 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-1 { + width: 8.3333333333%; +} + +.offset-1 { + margin-left: 8.3333333333%; +} + +.col-2 { + width: 16.6666666667%; +} + +.offset-2 { + margin-left: 16.6666666667%; +} + +.col-3 { + width: 25%; +} + +.offset-3 { + margin-left: 25%; +} + +.col-4 { + width: 33.3333333333%; +} + +.offset-4 { + margin-left: 33.3333333333%; +} + +.col-5 { + width: 41.6666666667%; +} + +.offset-5 { + margin-left: 41.6666666667%; +} + +.col-6 { + width: 50%; +} + +.offset-6 { + margin-left: 50%; +} + +.col-7 { + width: 58.3333333333%; +} + +.offset-7 { + margin-left: 58.3333333333%; +} + +.col-8 { + width: 66.6666666667%; +} + +.offset-8 { + margin-left: 66.6666666667%; +} + +.col-9 { + width: 75%; +} + +.offset-9 { + margin-left: 75%; +} + +.col-10 { + width: 83.3333333333%; +} + +.offset-10 { + margin-left: 83.3333333333%; +} + +.col-11 { + width: 91.6666666667%; +} + +.offset-11 { + margin-left: 91.6666666667%; +} + +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(../images/icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(../images/icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -187px; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: #fdfdfd; + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: #222; +} + +a { + color: #4da6ff; + text-decoration: none; +} +a:hover { + text-decoration: underline; +} + +code, pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; + background-color: rgba(0, 0, 0, 0.04); +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; + background-color: transparent; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, .tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, .tsd-typography ul, .tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html.default .col-content { + width: 72%; + } + html.default .col-menu { + width: 28%; + } + html.default .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html.default .col-content { + float: none; + width: 100%; + } + html.default .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: #fff; + transform: translate(100%, 0); + } + html.default .col-menu > *:last-child { + padding-bottom: 20px; + } + html.default .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + html.default.to-has-menu .overlay { + animation: fade-in 0.4s; + } + html.default.to-has-menu header, +html.default.to-has-menu footer, +html.default.to-has-menu .col-content { + animation: shift-to-left 0.4s; + } + html.default.to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + html.default.from-has-menu .overlay { + animation: fade-out 0.4s; + } + html.default.from-has-menu header, +html.default.from-has-menu footer, +html.default.from-has-menu .col-content { + animation: unshift-to-left 0.4s; + } + html.default.from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + html.default.has-menu body { + overflow: hidden; + } + html.default.has-menu .overlay { + visibility: visible; + } + html.default.has-menu header, +html.default.has-menu footer, +html.default.has-menu .col-content { + transform: translate(-25%, 0); + } + html.default.has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: #fff; + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: #707070; +} +.tsd-breadcrumb a { + color: #707070; + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +html.minimal .container { + margin: 0; +} +html.minimal .container-main { + padding-top: 50px; + padding-bottom: 0; +} +html.minimal .content-wrap { + padding-left: 300px; +} +html.minimal .tsd-navigation { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + box-sizing: border-box; + z-index: 1; + left: 0; + top: 40px; + bottom: 0; + width: 300px; + padding: 20px; + margin: 0; +} +html.minimal .tsd-member .tsd-member { + margin-left: 0; +} +html.minimal .tsd-page-toolbar { + position: fixed; + z-index: 2; +} +html.minimal #tsd-filter .tsd-filter-group { + right: 0; + transform: none; +} +html.minimal footer { + background-color: transparent; +} +html.minimal footer .container { + padding: 0; +} +html.minimal .tsd-generator { + padding: 0; +} +@media (max-width: 900px) { + html.minimal .tsd-navigation { + display: none; + } + html.minimal .content-wrap { + padding-left: 0; + } +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid #707070; + color: #707070; + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: #fff; + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, +#tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid #eee; + background-color: #fff; +} +footer.with-border-bottom { + border-bottom: 1px solid #eee; +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid #eee; +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: #9600ff; +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: #647F1B; +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: #937210; +} +.tsd-index-panel .tsd-parent-kind-class a { + color: #0672DE; +} +.tsd-index-panel .tsd-kind-module a { + color: #9600ff; +} +.tsd-index-panel .tsd-kind-interface a { + color: #647F1B; +} +.tsd-index-panel .tsd-kind-enum a { + color: #937210; +} +.tsd-index-panel .tsd-kind-class a { + color: #0672DE; +} +.tsd-index-panel .tsd-is-private a { + color: #707070; +} + +.tsd-flag { + display: inline-block; + padding: 1px 5px; + border-radius: 4px; + color: #fff; + background-color: #707070; + text-indent: 0; + font-size: 14px; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member a[data-tsd-kind] { + color: #9600ff; +} +.tsd-member a[data-tsd-kind=Interface] { + color: #647F1B; +} +.tsd-member a[data-tsd-kind=Enum] { + color: #937210; +} +.tsd-member a[data-tsd-kind=Class] { + color: #0672DE; +} +.tsd-member a[data-tsd-kind=Private] { + color: #707070; +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: #222; + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid #eee; +} +.tsd-navigation.primary li { + border-top: 1px solid #eee; +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: #707070; +} +.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: -webkit-sticky; + position: sticky; + top: calc(.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: #eee; +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: #000; +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: #eee; +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: #fff; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid #eee; +} +.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, .tsd-panel table td { + padding: 6px 13px; + border: 1px solid #ddd; +} +.tsd-panel table tr { + background-color: #fff; + border-top: 1px solid #ccc; +} +.tsd-panel table tr:nth-child(2n) { + background-color: #f8f8f8; +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: #222; +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: #fdfdfd; +} +#tsd-search .results li:nth-child(even) { + background-color: #fff; +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: #eee; +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: #707070; + font-weight: normal; +} +#tsd-search.has-focus { + background-color: #eee; +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid #eee; + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: #707070; + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid #eee; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: #eee; +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: #707070; + margin: 0 0 1em 0; +} +.tsd-sources a { + color: #707070; + text-decoration: underline; +} +.tsd-sources ul, .tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: #333; + background: #fff; + border-bottom: 1px solid #eee; + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: #333; + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(../images/widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + background-image: url(../images/widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.6; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.8; +} +.tsd-widget.active { + opacity: 1; + background-color: #eee; +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, .tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, .tsd-widget.menu { + display: inline-block; + } +} +input[type=checkbox] + .tsd-widget:before { + background-position: -120px 0; +} +input[type=checkbox]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: #fdfdfd; +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: #fff; +} +.tsd-select .tsd-select-list li:hover { + background-color: #eee; +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} diff --git a/master/assets/hierarchy.js b/master/assets/hierarchy.js deleted file mode 100644 index fab6caf8d..000000000 --- a/master/assets/hierarchy.js +++ /dev/null @@ -1 +0,0 @@ -window.hierarchyData = "eJydkstqwzAQRf9l1oqL5AeKdn1CwVCT0lXIQrXHsYgsB0tehOB/L3ZIsNM02N1oIc2dc+9ojlBXlbMg1jRghHFO/CgiNNgQqDHXmDpVGQviCDToTiNLBAFJ861V+pi8x2qHQGCnTAaChRGBptYgQBmHdS5TtA+f6Jq9N1J4hSs1EEi1tBYEOJstuhaLi6x7LJTOajQg1oxuWgKM3nJwoVPGz/S+72/0n9jTRUuABmzAeJIW40pmH/vTFO7nfK5MrrbelWhuVMo5YX7Y5aWcD8x8reLZXsaaCVa6KfvhgPoinZyNvRJN5I7Svmlpi+Hv3gYmWh6w9s7Vs/dqGfSLtRztdt/zVWOJxk3jjyTT4vpRNGDGuJXpYdXkucbJqa9E/wrftj8ciVEy" \ No newline at end of file diff --git a/master/assets/highlight.css b/master/assets/highlight.css deleted file mode 100644 index 9ca4e01a9..000000000 --- a/master/assets/highlight.css +++ /dev/null @@ -1,99 +0,0 @@ -:root { - --light-hl-0: #800000; - --dark-hl-0: #808080; - --light-hl-1: #800000; - --dark-hl-1: #569CD6; - --light-hl-2: #000000FF; - --dark-hl-2: #D4D4D4; - --light-hl-3: #E50000; - --dark-hl-3: #9CDCFE; - --light-hl-4: #0000FF; - --dark-hl-4: #CE9178; - --light-hl-5: #001080; - --dark-hl-5: #9CDCFE; - --light-hl-6: #000000; - --dark-hl-6: #D4D4D4; - --light-hl-7: #795E26; - --dark-hl-7: #DCDCAA; - --light-hl-8: #A31515; - --dark-hl-8: #CE9178; - --light-hl-9: #0000FF; - --dark-hl-9: #569CD6; - --light-hl-10: #098658; - --dark-hl-10: #B5CEA8; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --code-background: var(--dark-code-background); -} } - -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --code-background: var(--light-code-background); -} - -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -.hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } -pre, code { background: var(--code-background); } diff --git a/master/assets/icons.js b/master/assets/icons.js deleted file mode 100644 index 58882d76d..000000000 --- a/master/assets/icons.js +++ /dev/null @@ -1,18 +0,0 @@ -(function() { - addIcons(); - function addIcons() { - if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); - const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; - svg.style.display = "none"; - if (location.protocol === "file:") updateUseElements(); - } - - function updateUseElements() { - document.querySelectorAll("use").forEach(el => { - if (el.getAttribute("href").includes("#icon-")) { - el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); - } - }); - } -})() \ No newline at end of file diff --git a/master/assets/icons.svg b/master/assets/icons.svg deleted file mode 100644 index 50ad5799d..000000000 --- a/master/assets/icons.svg +++ /dev/null @@ -1 +0,0 @@ -MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/master/assets/images/icons.png b/master/assets/images/icons.png new file mode 100644 index 000000000..3836d5fe4 Binary files /dev/null and b/master/assets/images/icons.png differ diff --git a/master/assets/images/icons@2x.png b/master/assets/images/icons@2x.png new file mode 100644 index 000000000..5a209e2f6 Binary files /dev/null and b/master/assets/images/icons@2x.png differ diff --git a/master/assets/images/widgets.png b/master/assets/images/widgets.png new file mode 100644 index 000000000..c7380532a Binary files /dev/null and b/master/assets/images/widgets.png differ diff --git a/master/assets/images/widgets@2x.png b/master/assets/images/widgets@2x.png new file mode 100644 index 000000000..4bbbd5727 Binary files /dev/null and b/master/assets/images/widgets@2x.png differ diff --git a/master/assets/js/main.js b/master/assets/js/main.js new file mode 100644 index 000000000..f8f96a606 --- /dev/null +++ b/master/assets/js/main.js @@ -0,0 +1,248 @@ +/* + * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development"). + * This devtool is not neither made for production nor for readable output files. + * It uses "eval()" calls to create a separate source file in the browser devtools. + * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/) + * or disable the default devtool with "devtool: false". + * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/). + */ +/******/ (() => { // webpackBootstrap +/******/ var __webpack_modules__ = ({ + +/***/ "../node_modules/lunr/lunr.js": +/*!************************************!*\ + !*** ../node_modules/lunr/lunr.js ***! + \************************************/ +/***/ ((module, exports, __webpack_require__) => { + +eval("var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object} attrs.fieldVectors - Field vectors\n * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens.\n * @param {string[]} attrs.fields - The names of indexed document fields.\n * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms.\n */\nlunr.Index = function (attrs) {\n this.invertedIndex = attrs.invertedIndex\n this.fieldVectors = attrs.fieldVectors\n this.tokenSet = attrs.tokenSet\n this.fields = attrs.fields\n this.pipeline = attrs.pipeline\n}\n\n/**\n * A result contains details of a document matching a search query.\n * @typedef {Object} lunr.Index~Result\n * @property {string} ref - The reference of the document this result represents.\n * @property {number} score - A number between 0 and 1 representing how similar this document is to the query.\n * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match.\n */\n\n/**\n * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple\n * query language which itself is parsed into an instance of lunr.Query.\n *\n * For programmatically building queries it is advised to directly use lunr.Query, the query language\n * is best used for human entered text rather than program generated text.\n *\n * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported\n * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello'\n * or 'world', though those that contain both will rank higher in the results.\n *\n * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can\n * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding\n * wildcards will increase the number of documents that will be found but can also have a negative\n * impact on query performance, especially with wildcards at the beginning of a term.\n *\n * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term\n * hello in the title field will match this query. Using a field not present in the index will lead\n * to an error being thrown.\n *\n * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term\n * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported\n * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2.\n * Avoid large values for edit distance to improve query performance.\n *\n * Each term also supports a presence modifier. By default a term's presence in document is optional, however\n * this can be changed to either required or prohibited. For a term's presence to be required in a document the\n * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and\n * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not\n * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'.\n *\n * To escape special characters the backslash character '\\' can be used, this allows searches to include\n * characters that would normally be considered modifiers, e.g. `foo\\~2` will search for a term \"foo~2\" instead\n * of attempting to apply a boost of 2 to the search term \"foo\".\n *\n * @typedef {string} lunr.Index~QueryString\n * @example Simple single term query\n * hello\n * @example Multiple term query\n * hello world\n * @example term scoped to a field\n * title:hello\n * @example term with a boost of 10\n * hello^10\n * @example term with an edit distance of 2\n * hello~2\n * @example terms with presence modifiers\n * -foo +bar baz\n */\n\n/**\n * Performs a search against the index using lunr query syntax.\n *\n * Results will be returned sorted by their score, the most relevant results\n * will be returned first. For details on how the score is calculated, please see\n * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}.\n *\n * For more programmatic querying use lunr.Index#query.\n *\n * @param {lunr.Index~QueryString} queryString - A string containing a lunr query.\n * @throws {lunr.QueryParseError} If the passed query string cannot be parsed.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.search = function (queryString) {\n return this.query(function (query) {\n var parser = new lunr.QueryParser(queryString, query)\n parser.parse()\n })\n}\n\n/**\n * A query builder callback provides a query object to be used to express\n * the query to perform on the index.\n *\n * @callback lunr.Index~queryBuilder\n * @param {lunr.Query} query - The query object to build up.\n * @this lunr.Query\n */\n\n/**\n * Performs a query against the index using the yielded lunr.Query object.\n *\n * If performing programmatic queries against the index, this method is preferred\n * over lunr.Index#search so as to avoid the additional query parsing overhead.\n *\n * A query object is yielded to the supplied function which should be used to\n * express the query to be run against the index.\n *\n * Note that although this function takes a callback parameter it is _not_ an\n * asynchronous operation, the callback is just yielded a query object to be\n * customized.\n *\n * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.query = function (fn) {\n // for each query clause\n // * process terms\n // * expand terms from token set\n // * find matching documents and metadata\n // * get document vectors\n // * score documents\n\n var query = new lunr.Query(this.fields),\n matchingFields = Object.create(null),\n queryVectors = Object.create(null),\n termFieldCache = Object.create(null),\n requiredMatches = Object.create(null),\n prohibitedMatches = Object.create(null)\n\n /*\n * To support field level boosts a query vector is created per\n * field. An empty vector is eagerly created to support negated\n * queries.\n */\n for (var i = 0; i < this.fields.length; i++) {\n queryVectors[this.fields[i]] = new lunr.Vector\n }\n\n fn.call(query, query)\n\n for (var i = 0; i < query.clauses.length; i++) {\n /*\n * Unless the pipeline has been disabled for this term, which is\n * the case for terms with wildcards, we need to pass the clause\n * term through the search pipeline. A pipeline returns an array\n * of processed terms. Pipeline functions may expand the passed\n * term, which means we may end up performing multiple index lookups\n * for a single query term.\n */\n var clause = query.clauses[i],\n terms = null,\n clauseMatches = lunr.Set.empty\n\n if (clause.usePipeline) {\n terms = this.pipeline.runString(clause.term, {\n fields: clause.fields\n })\n } else {\n terms = [clause.term]\n }\n\n for (var m = 0; m < terms.length; m++) {\n var term = terms[m]\n\n /*\n * Each term returned from the pipeline needs to use the same query\n * clause object, e.g. the same boost and or edit distance. The\n * simplest way to do this is to re-use the clause object but mutate\n * its term property.\n */\n clause.term = term\n\n /*\n * From the term in the clause we create a token set which will then\n * be used to intersect the indexes token set to get a list of terms\n * to lookup in the inverted index\n */\n var termTokenSet = lunr.TokenSet.fromClause(clause),\n expandedTerms = this.tokenSet.intersect(termTokenSet).toArray()\n\n /*\n * If a term marked as required does not exist in the tokenSet it is\n * impossible for the search to return any matches. We set all the field\n * scoped required matches set to empty and stop examining any further\n * clauses.\n */\n if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = lunr.Set.empty\n }\n\n break\n }\n\n for (var j = 0; j < expandedTerms.length; j++) {\n /*\n * For each term get the posting and termIndex, this is required for\n * building the query vector.\n */\n var expandedTerm = expandedTerms[j],\n posting = this.invertedIndex[expandedTerm],\n termIndex = posting._index\n\n for (var k = 0; k < clause.fields.length; k++) {\n /*\n * For each field that this query term is scoped by (by default\n * all fields are in scope) we need to get all the document refs\n * that have this term in that field.\n *\n * The posting is the entry in the invertedIndex for the matching\n * term from above.\n */\n var field = clause.fields[k],\n fieldPosting = posting[field],\n matchingDocumentRefs = Object.keys(fieldPosting),\n termField = expandedTerm + \"/\" + field,\n matchingDocumentsSet = new lunr.Set(matchingDocumentRefs)\n\n /*\n * if the presence of this term is required ensure that the matching\n * documents are added to the set of required matches for this clause.\n *\n */\n if (clause.presence == lunr.Query.presence.REQUIRED) {\n clauseMatches = clauseMatches.union(matchingDocumentsSet)\n\n if (requiredMatches[field] === undefined) {\n requiredMatches[field] = lunr.Set.complete\n }\n }\n\n /*\n * if the presence of this term is prohibited ensure that the matching\n * documents are added to the set of prohibited matches for this field,\n * creating that set if it does not yet exist.\n */\n if (clause.presence == lunr.Query.presence.PROHIBITED) {\n if (prohibitedMatches[field] === undefined) {\n prohibitedMatches[field] = lunr.Set.empty\n }\n\n prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet)\n\n /*\n * Prohibited matches should not be part of the query vector used for\n * similarity scoring and no metadata should be extracted so we continue\n * to the next field\n */\n continue\n }\n\n /*\n * The query field vector is populated using the termIndex found for\n * the term and a unit value with the appropriate boost applied.\n * Using upsert because there could already be an entry in the vector\n * for the term we are working with. In that case we just add the scores\n * together.\n */\n queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b })\n\n /**\n * If we've already seen this term, field combo then we've already collected\n * the matching documents and metadata, no need to go through all that again\n */\n if (termFieldCache[termField]) {\n continue\n }\n\n for (var l = 0; l < matchingDocumentRefs.length; l++) {\n /*\n * All metadata for this term/field/document triple\n * are then extracted and collected into an instance\n * of lunr.MatchData ready to be returned in the query\n * results\n */\n var matchingDocumentRef = matchingDocumentRefs[l],\n matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field),\n metadata = fieldPosting[matchingDocumentRef],\n fieldMatch\n\n if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) {\n matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata)\n } else {\n fieldMatch.add(expandedTerm, field, metadata)\n }\n\n }\n\n termFieldCache[termField] = true\n }\n }\n }\n\n /**\n * If the presence was required we need to update the requiredMatches field sets.\n * We do this after all fields for the term have collected their matches because\n * the clause terms presence is required in _any_ of the fields not _all_ of the\n * fields.\n */\n if (clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = requiredMatches[field].intersect(clauseMatches)\n }\n }\n }\n\n /**\n * Need to combine the field scoped required and prohibited\n * matching documents into a global set of required and prohibited\n * matches\n */\n var allRequiredMatches = lunr.Set.complete,\n allProhibitedMatches = lunr.Set.empty\n\n for (var i = 0; i < this.fields.length; i++) {\n var field = this.fields[i]\n\n if (requiredMatches[field]) {\n allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field])\n }\n\n if (prohibitedMatches[field]) {\n allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field])\n }\n }\n\n var matchingFieldRefs = Object.keys(matchingFields),\n results = [],\n matches = Object.create(null)\n\n /*\n * If the query is negated (contains only prohibited terms)\n * we need to get _all_ fieldRefs currently existing in the\n * index. This is only done when we know that the query is\n * entirely prohibited terms to avoid any cost of getting all\n * fieldRefs unnecessarily.\n *\n * Additionally, blank MatchData must be created to correctly\n * populate the results.\n */\n if (query.isNegated()) {\n matchingFieldRefs = Object.keys(this.fieldVectors)\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n var matchingFieldRef = matchingFieldRefs[i]\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRef)\n matchingFields[matchingFieldRef] = new lunr.MatchData\n }\n }\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n /*\n * Currently we have document fields that match the query, but we\n * need to return documents. The matchData and scores are combined\n * from multiple fields belonging to the same document.\n *\n * Scores are calculated by field, using the query vectors created\n * above, and combined into a final document score using addition.\n */\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]),\n docRef = fieldRef.docRef\n\n if (!allRequiredMatches.contains(docRef)) {\n continue\n }\n\n if (allProhibitedMatches.contains(docRef)) {\n continue\n }\n\n var fieldVector = this.fieldVectors[fieldRef],\n score = queryVectors[fieldRef.fieldName].similarity(fieldVector),\n docMatch\n\n if ((docMatch = matches[docRef]) !== undefined) {\n docMatch.score += score\n docMatch.matchData.combine(matchingFields[fieldRef])\n } else {\n var match = {\n ref: docRef,\n score: score,\n matchData: matchingFields[fieldRef]\n }\n matches[docRef] = match\n results.push(match)\n }\n }\n\n /*\n * Sort the results objects by score, highest first.\n */\n return results.sort(function (a, b) {\n return b.score - a.score\n })\n}\n\n/**\n * Prepares the index for JSON serialization.\n *\n * The schema for this JSON blob will be described in a\n * separate JSON schema file.\n *\n * @returns {Object}\n */\nlunr.Index.prototype.toJSON = function () {\n var invertedIndex = Object.keys(this.invertedIndex)\n .sort()\n .map(function (term) {\n return [term, this.invertedIndex[term]]\n }, this)\n\n var fieldVectors = Object.keys(this.fieldVectors)\n .map(function (ref) {\n return [ref, this.fieldVectors[ref].toJSON()]\n }, this)\n\n return {\n version: lunr.version,\n fields: this.fields,\n fieldVectors: fieldVectors,\n invertedIndex: invertedIndex,\n pipeline: this.pipeline.toJSON()\n }\n}\n\n/**\n * Loads a previously serialized lunr.Index\n *\n * @param {Object} serializedIndex - A previously serialized lunr.Index\n * @returns {lunr.Index}\n */\nlunr.Index.load = function (serializedIndex) {\n var attrs = {},\n fieldVectors = {},\n serializedVectors = serializedIndex.fieldVectors,\n invertedIndex = Object.create(null),\n serializedInvertedIndex = serializedIndex.invertedIndex,\n tokenSetBuilder = new lunr.TokenSet.Builder,\n pipeline = lunr.Pipeline.load(serializedIndex.pipeline)\n\n if (serializedIndex.version != lunr.version) {\n lunr.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\" + lunr.version + \"' does not match serialized index '\" + serializedIndex.version + \"'\")\n }\n\n for (var i = 0; i < serializedVectors.length; i++) {\n var tuple = serializedVectors[i],\n ref = tuple[0],\n elements = tuple[1]\n\n fieldVectors[ref] = new lunr.Vector(elements)\n }\n\n for (var i = 0; i < serializedInvertedIndex.length; i++) {\n var tuple = serializedInvertedIndex[i],\n term = tuple[0],\n posting = tuple[1]\n\n tokenSetBuilder.insert(term)\n invertedIndex[term] = posting\n }\n\n tokenSetBuilder.finish()\n\n attrs.fields = serializedIndex.fields\n\n attrs.fieldVectors = fieldVectors\n attrs.invertedIndex = invertedIndex\n attrs.tokenSet = tokenSetBuilder.root\n attrs.pipeline = pipeline\n\n return new lunr.Index(attrs)\n}\n/*!\n * lunr.Builder\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Builder performs indexing on a set of documents and\n * returns instances of lunr.Index ready for querying.\n *\n * All configuration of the index is done via the builder, the\n * fields to index, the document reference, the text processing\n * pipeline and document scoring parameters are all set on the\n * builder before indexing.\n *\n * @constructor\n * @property {string} _ref - Internal reference to the document reference field.\n * @property {string[]} _fields - Internal reference to the document fields to index.\n * @property {object} invertedIndex - The inverted index maps terms to document fields.\n * @property {object} documentTermFrequencies - Keeps track of document term frequencies.\n * @property {object} documentLengths - Keeps track of the length of documents added to the index.\n * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing.\n * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing.\n * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index.\n * @property {number} documentCount - Keeps track of the total number of documents indexed.\n * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.\n * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.\n * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.\n * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.\n */\nlunr.Builder = function () {\n this._ref = \"id\"\n this._fields = Object.create(null)\n this._documents = Object.create(null)\n this.invertedIndex = Object.create(null)\n this.fieldTermFrequencies = {}\n this.fieldLengths = {}\n this.tokenizer = lunr.tokenizer\n this.pipeline = new lunr.Pipeline\n this.searchPipeline = new lunr.Pipeline\n this.documentCount = 0\n this._b = 0.75\n this._k1 = 1.2\n this.termIndex = 0\n this.metadataWhitelist = []\n}\n\n/**\n * Sets the document field used as the document reference. Every document must have this field.\n * The type of this field in the document should be a string, if it is not a string it will be\n * coerced into a string by calling toString.\n *\n * The default ref is 'id'.\n *\n * The ref should _not_ be changed during indexing, it should be set before any documents are\n * added to the index. Changing it during indexing can lead to inconsistent results.\n *\n * @param {string} ref - The name of the reference field in the document.\n */\nlunr.Builder.prototype.ref = function (ref) {\n this._ref = ref\n}\n\n/**\n * A function that is used to extract a field from a document.\n *\n * Lunr expects a field to be at the top level of a document, if however the field\n * is deeply nested within a document an extractor function can be used to extract\n * the right field for indexing.\n *\n * @callback fieldExtractor\n * @param {object} doc - The document being added to the index.\n * @returns {?(string|object|object[])} obj - The object that will be indexed for this field.\n * @example Extracting a nested field\n * function (doc) { return doc.nested.field }\n */\n\n/**\n * Adds a field to the list of document fields that will be indexed. Every document being\n * indexed should have this field. Null values for this field in indexed documents will\n * not cause errors but will limit the chance of that document being retrieved by searches.\n *\n * All fields should be added before adding documents to the index. Adding fields after\n * a document has been indexed will have no effect on already indexed documents.\n *\n * Fields can be boosted at build time. This allows terms within that field to have more\n * importance when ranking search results. Use a field boost to specify that matches within\n * one field are more important than other fields.\n *\n * @param {string} fieldName - The name of a field to index in all documents.\n * @param {object} attributes - Optional attributes associated with this field.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this field.\n * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document.\n * @throws {RangeError} fieldName cannot contain unsupported characters '/'\n */\nlunr.Builder.prototype.field = function (fieldName, attributes) {\n if (/\\//.test(fieldName)) {\n throw new RangeError (\"Field '\" + fieldName + \"' contains illegal character '/'\")\n }\n\n this._fields[fieldName] = attributes || {}\n}\n\n/**\n * A parameter to tune the amount of field length normalisation that is applied when\n * calculating relevance scores. A value of 0 will completely disable any normalisation\n * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b\n * will be clamped to the range 0 - 1.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.b = function (number) {\n if (number < 0) {\n this._b = 0\n } else if (number > 1) {\n this._b = 1\n } else {\n this._b = number\n }\n}\n\n/**\n * A parameter that controls the speed at which a rise in term frequency results in term\n * frequency saturation. The default value is 1.2. Setting this to a higher value will give\n * slower saturation levels, a lower value will result in quicker saturation.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.k1 = function (number) {\n this._k1 = number\n}\n\n/**\n * Adds a document to the index.\n *\n * Before adding fields to the index the index should have been fully setup, with the document\n * ref and all fields to index already having been specified.\n *\n * The document must have a field name as specified by the ref (by default this is 'id') and\n * it should have all fields defined for indexing, though null or undefined values will not\n * cause errors.\n *\n * Entire documents can be boosted at build time. Applying a boost to a document indicates that\n * this document should rank higher in search results than other documents.\n *\n * @param {object} doc - The document to add to the index.\n * @param {object} attributes - Optional attributes associated with this document.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this document.\n */\nlunr.Builder.prototype.add = function (doc, attributes) {\n var docRef = doc[this._ref],\n fields = Object.keys(this._fields)\n\n this._documents[docRef] = attributes || {}\n this.documentCount += 1\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i],\n extractor = this._fields[fieldName].extractor,\n field = extractor ? extractor(doc) : doc[fieldName],\n tokens = this.tokenizer(field, {\n fields: [fieldName]\n }),\n terms = this.pipeline.run(tokens),\n fieldRef = new lunr.FieldRef (docRef, fieldName),\n fieldTerms = Object.create(null)\n\n this.fieldTermFrequencies[fieldRef] = fieldTerms\n this.fieldLengths[fieldRef] = 0\n\n // store the length of this field for this document\n this.fieldLengths[fieldRef] += terms.length\n\n // calculate term frequencies for this field\n for (var j = 0; j < terms.length; j++) {\n var term = terms[j]\n\n if (fieldTerms[term] == undefined) {\n fieldTerms[term] = 0\n }\n\n fieldTerms[term] += 1\n\n // add to inverted index\n // create an initial posting if one doesn't exist\n if (this.invertedIndex[term] == undefined) {\n var posting = Object.create(null)\n posting[\"_index\"] = this.termIndex\n this.termIndex += 1\n\n for (var k = 0; k < fields.length; k++) {\n posting[fields[k]] = Object.create(null)\n }\n\n this.invertedIndex[term] = posting\n }\n\n // add an entry for this term/fieldName/docRef to the invertedIndex\n if (this.invertedIndex[term][fieldName][docRef] == undefined) {\n this.invertedIndex[term][fieldName][docRef] = Object.create(null)\n }\n\n // store all whitelisted metadata about this token in the\n // inverted index\n for (var l = 0; l < this.metadataWhitelist.length; l++) {\n var metadataKey = this.metadataWhitelist[l],\n metadata = term.metadata[metadataKey]\n\n if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {\n this.invertedIndex[term][fieldName][docRef][metadataKey] = []\n }\n\n this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata)\n }\n }\n\n }\n}\n\n/**\n * Calculates the average document length for this index\n *\n * @private\n */\nlunr.Builder.prototype.calculateAverageFieldLengths = function () {\n\n var fieldRefs = Object.keys(this.fieldLengths),\n numberOfFields = fieldRefs.length,\n accumulator = {},\n documentsWithField = {}\n\n for (var i = 0; i < numberOfFields; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n field = fieldRef.fieldName\n\n documentsWithField[field] || (documentsWithField[field] = 0)\n documentsWithField[field] += 1\n\n accumulator[field] || (accumulator[field] = 0)\n accumulator[field] += this.fieldLengths[fieldRef]\n }\n\n var fields = Object.keys(this._fields)\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i]\n accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]\n }\n\n this.averageFieldLength = accumulator\n}\n\n/**\n * Builds a vector space model of every document using lunr.Vector\n *\n * @private\n */\nlunr.Builder.prototype.createFieldVectors = function () {\n var fieldVectors = {},\n fieldRefs = Object.keys(this.fieldTermFrequencies),\n fieldRefsLength = fieldRefs.length,\n termIdfCache = Object.create(null)\n\n for (var i = 0; i < fieldRefsLength; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n fieldName = fieldRef.fieldName,\n fieldLength = this.fieldLengths[fieldRef],\n fieldVector = new lunr.Vector,\n termFrequencies = this.fieldTermFrequencies[fieldRef],\n terms = Object.keys(termFrequencies),\n termsLength = terms.length\n\n\n var fieldBoost = this._fields[fieldName].boost || 1,\n docBoost = this._documents[fieldRef.docRef].boost || 1\n\n for (var j = 0; j < termsLength; j++) {\n var term = terms[j],\n tf = termFrequencies[term],\n termIndex = this.invertedIndex[term]._index,\n idf, score, scoreWithPrecision\n\n if (termIdfCache[term] === undefined) {\n idf = lunr.idf(this.invertedIndex[term], this.documentCount)\n termIdfCache[term] = idf\n } else {\n idf = termIdfCache[term]\n }\n\n score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf)\n score *= fieldBoost\n score *= docBoost\n scoreWithPrecision = Math.round(score * 1000) / 1000\n // Converts 1.23456789 to 1.234.\n // Reducing the precision so that the vectors take up less\n // space when serialised. Doing it now so that they behave\n // the same before and after serialisation. Also, this is\n // the fastest approach to reducing a number's precision in\n // JavaScript.\n\n fieldVector.insert(termIndex, scoreWithPrecision)\n }\n\n fieldVectors[fieldRef] = fieldVector\n }\n\n this.fieldVectors = fieldVectors\n}\n\n/**\n * Creates a token set of all tokens in the index using lunr.TokenSet\n *\n * @private\n */\nlunr.Builder.prototype.createTokenSet = function () {\n this.tokenSet = lunr.TokenSet.fromArray(\n Object.keys(this.invertedIndex).sort()\n )\n}\n\n/**\n * Builds the index, creating an instance of lunr.Index.\n *\n * This completes the indexing process and should only be called\n * once all documents have been added to the index.\n *\n * @returns {lunr.Index}\n */\nlunr.Builder.prototype.build = function () {\n this.calculateAverageFieldLengths()\n this.createFieldVectors()\n this.createTokenSet()\n\n return new lunr.Index({\n invertedIndex: this.invertedIndex,\n fieldVectors: this.fieldVectors,\n tokenSet: this.tokenSet,\n fields: Object.keys(this._fields),\n pipeline: this.searchPipeline\n })\n}\n\n/**\n * Applies a plugin to the index builder.\n *\n * A plugin is a function that is called with the index builder as its context.\n * Plugins can be used to customise or extend the behaviour of the index\n * in some way. A plugin is just a function, that encapsulated the custom\n * behaviour that should be applied when building the index.\n *\n * The plugin function will be called with the index builder as its argument, additional\n * arguments can also be passed when calling use. The function will be called\n * with the index builder as its context.\n *\n * @param {Function} plugin The plugin to apply.\n */\nlunr.Builder.prototype.use = function (fn) {\n var args = Array.prototype.slice.call(arguments, 1)\n args.unshift(this)\n fn.apply(this, args)\n}\n/**\n * Contains and collects metadata about a matching document.\n * A single instance of lunr.MatchData is returned as part of every\n * lunr.Index~Result.\n *\n * @constructor\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n * @property {object} metadata - A cloned collection of metadata associated with this document.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData = function (term, field, metadata) {\n var clonedMetadata = Object.create(null),\n metadataKeys = Object.keys(metadata || {})\n\n // Cloning the metadata to prevent the original\n // being mutated during match data combination.\n // Metadata is kept in an array within the inverted\n // index so cloning the data can be done with\n // Array#slice\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n clonedMetadata[key] = metadata[key].slice()\n }\n\n this.metadata = Object.create(null)\n\n if (term !== undefined) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = clonedMetadata\n }\n}\n\n/**\n * An instance of lunr.MatchData will be created for every term that matches a\n * document. However only one instance is required in a lunr.Index~Result. This\n * method combines metadata from another instance of lunr.MatchData with this\n * objects metadata.\n *\n * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData.prototype.combine = function (otherMatchData) {\n var terms = Object.keys(otherMatchData.metadata)\n\n for (var i = 0; i < terms.length; i++) {\n var term = terms[i],\n fields = Object.keys(otherMatchData.metadata[term])\n\n if (this.metadata[term] == undefined) {\n this.metadata[term] = Object.create(null)\n }\n\n for (var j = 0; j < fields.length; j++) {\n var field = fields[j],\n keys = Object.keys(otherMatchData.metadata[term][field])\n\n if (this.metadata[term][field] == undefined) {\n this.metadata[term][field] = Object.create(null)\n }\n\n for (var k = 0; k < keys.length; k++) {\n var key = keys[k]\n\n if (this.metadata[term][field][key] == undefined) {\n this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]\n } else {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key])\n }\n\n }\n }\n }\n}\n\n/**\n * Add metadata for a term/field pair to this instance of match data.\n *\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n */\nlunr.MatchData.prototype.add = function (term, field, metadata) {\n if (!(term in this.metadata)) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = metadata\n return\n }\n\n if (!(field in this.metadata[term])) {\n this.metadata[term][field] = metadata\n return\n }\n\n var metadataKeys = Object.keys(metadata)\n\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n\n if (key in this.metadata[term][field]) {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key])\n } else {\n this.metadata[term][field][key] = metadata[key]\n }\n }\n}\n/**\n * A lunr.Query provides a programmatic way of defining queries to be performed\n * against a {@link lunr.Index}.\n *\n * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method\n * so the query object is pre-initialized with the right index fields.\n *\n * @constructor\n * @property {lunr.Query~Clause[]} clauses - An array of query clauses.\n * @property {string[]} allFields - An array of all available fields in a lunr.Index.\n */\nlunr.Query = function (allFields) {\n this.clauses = []\n this.allFields = allFields\n}\n\n/**\n * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause.\n *\n * This allows wildcards to be added to the beginning and end of a term without having to manually do any string\n * concatenation.\n *\n * The wildcard constants can be bitwise combined to select both leading and trailing wildcards.\n *\n * @constant\n * @default\n * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour\n * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists\n * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with trailing wildcard\n * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })\n * @example query term with leading and trailing wildcard\n * query.term('foo', {\n * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING\n * })\n */\n\nlunr.Query.wildcard = new String (\"*\")\nlunr.Query.wildcard.NONE = 0\nlunr.Query.wildcard.LEADING = 1\nlunr.Query.wildcard.TRAILING = 2\n\n/**\n * Constants for indicating what kind of presence a term must have in matching documents.\n *\n * @constant\n * @enum {number}\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with required presence\n * query.term('foo', { presence: lunr.Query.presence.REQUIRED })\n */\nlunr.Query.presence = {\n /**\n * Term's presence in a document is optional, this is the default value.\n */\n OPTIONAL: 1,\n\n /**\n * Term's presence in a document is required, documents that do not contain\n * this term will not be returned.\n */\n REQUIRED: 2,\n\n /**\n * Term's presence in a document is prohibited, documents that do contain\n * this term will not be returned.\n */\n PROHIBITED: 3\n}\n\n/**\n * A single clause in a {@link lunr.Query} contains a term and details on how to\n * match that term against a {@link lunr.Index}.\n *\n * @typedef {Object} lunr.Query~Clause\n * @property {string[]} fields - The fields in an index this clause should be matched against.\n * @property {number} [boost=1] - Any boost that should be applied when matching this clause.\n * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be.\n * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline.\n * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended.\n * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents.\n */\n\n/**\n * Adds a {@link lunr.Query~Clause} to this query.\n *\n * Unless the clause contains the fields to be matched all fields will be matched. In addition\n * a default boost of 1 is applied to the clause.\n *\n * @param {lunr.Query~Clause} clause - The clause to add to this query.\n * @see lunr.Query~Clause\n * @returns {lunr.Query}\n */\nlunr.Query.prototype.clause = function (clause) {\n if (!('fields' in clause)) {\n clause.fields = this.allFields\n }\n\n if (!('boost' in clause)) {\n clause.boost = 1\n }\n\n if (!('usePipeline' in clause)) {\n clause.usePipeline = true\n }\n\n if (!('wildcard' in clause)) {\n clause.wildcard = lunr.Query.wildcard.NONE\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) {\n clause.term = \"*\" + clause.term\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) {\n clause.term = \"\" + clause.term + \"*\"\n }\n\n if (!('presence' in clause)) {\n clause.presence = lunr.Query.presence.OPTIONAL\n }\n\n this.clauses.push(clause)\n\n return this\n}\n\n/**\n * A negated query is one in which every clause has a presence of\n * prohibited. These queries require some special processing to return\n * the expected results.\n *\n * @returns boolean\n */\nlunr.Query.prototype.isNegated = function () {\n for (var i = 0; i < this.clauses.length; i++) {\n if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause}\n * to the list of clauses that make up this query.\n *\n * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion\n * to a token or token-like string should be done before calling this method.\n *\n * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an\n * array, each term in the array will share the same options.\n *\n * @param {object|object[]} term - The term(s) to add to the query.\n * @param {object} [options] - Any additional properties to add to the query clause.\n * @returns {lunr.Query}\n * @see lunr.Query#clause\n * @see lunr.Query~Clause\n * @example adding a single term to a query\n * query.term(\"foo\")\n * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard\n * query.term(\"foo\", {\n * fields: [\"title\"],\n * boost: 10,\n * wildcard: lunr.Query.wildcard.TRAILING\n * })\n * @example using lunr.tokenizer to convert a string to tokens before using them as terms\n * query.term(lunr.tokenizer(\"foo bar\"))\n */\nlunr.Query.prototype.term = function (term, options) {\n if (Array.isArray(term)) {\n term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this)\n return this\n }\n\n var clause = options || {}\n clause.term = term.toString()\n\n this.clause(clause)\n\n return this\n}\nlunr.QueryParseError = function (message, start, end) {\n this.name = \"QueryParseError\"\n this.message = message\n this.start = start\n this.end = end\n}\n\nlunr.QueryParseError.prototype = new Error\nlunr.QueryLexer = function (str) {\n this.lexemes = []\n this.str = str\n this.length = str.length\n this.pos = 0\n this.start = 0\n this.escapeCharPositions = []\n}\n\nlunr.QueryLexer.prototype.run = function () {\n var state = lunr.QueryLexer.lexText\n\n while (state) {\n state = state(this)\n }\n}\n\nlunr.QueryLexer.prototype.sliceString = function () {\n var subSlices = [],\n sliceStart = this.start,\n sliceEnd = this.pos\n\n for (var i = 0; i < this.escapeCharPositions.length; i++) {\n sliceEnd = this.escapeCharPositions[i]\n subSlices.push(this.str.slice(sliceStart, sliceEnd))\n sliceStart = sliceEnd + 1\n }\n\n subSlices.push(this.str.slice(sliceStart, this.pos))\n this.escapeCharPositions.length = 0\n\n return subSlices.join('')\n}\n\nlunr.QueryLexer.prototype.emit = function (type) {\n this.lexemes.push({\n type: type,\n str: this.sliceString(),\n start: this.start,\n end: this.pos\n })\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.escapeCharacter = function () {\n this.escapeCharPositions.push(this.pos - 1)\n this.pos += 1\n}\n\nlunr.QueryLexer.prototype.next = function () {\n if (this.pos >= this.length) {\n return lunr.QueryLexer.EOS\n }\n\n var char = this.str.charAt(this.pos)\n this.pos += 1\n return char\n}\n\nlunr.QueryLexer.prototype.width = function () {\n return this.pos - this.start\n}\n\nlunr.QueryLexer.prototype.ignore = function () {\n if (this.start == this.pos) {\n this.pos += 1\n }\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.backup = function () {\n this.pos -= 1\n}\n\nlunr.QueryLexer.prototype.acceptDigitRun = function () {\n var char, charCode\n\n do {\n char = this.next()\n charCode = char.charCodeAt(0)\n } while (charCode > 47 && charCode < 58)\n\n if (char != lunr.QueryLexer.EOS) {\n this.backup()\n }\n}\n\nlunr.QueryLexer.prototype.more = function () {\n return this.pos < this.length\n}\n\nlunr.QueryLexer.EOS = 'EOS'\nlunr.QueryLexer.FIELD = 'FIELD'\nlunr.QueryLexer.TERM = 'TERM'\nlunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'\nlunr.QueryLexer.BOOST = 'BOOST'\nlunr.QueryLexer.PRESENCE = 'PRESENCE'\n\nlunr.QueryLexer.lexField = function (lexer) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.FIELD)\n lexer.ignore()\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexTerm = function (lexer) {\n if (lexer.width() > 1) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.TERM)\n }\n\n lexer.ignore()\n\n if (lexer.more()) {\n return lunr.QueryLexer.lexText\n }\n}\n\nlunr.QueryLexer.lexEditDistance = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.EDIT_DISTANCE)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexBoost = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.BOOST)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexEOS = function (lexer) {\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n}\n\n// This matches the separator used when tokenising fields\n// within a document. These should match otherwise it is\n// not possible to search for some tokens within a document.\n//\n// It is possible for the user to change the separator on the\n// tokenizer so it _might_ clash with any other of the special\n// characters already used within the search string, e.g. :.\n//\n// This means that it is possible to change the separator in\n// such a way that makes some words unsearchable using a search\n// string.\nlunr.QueryLexer.termSeparator = lunr.tokenizer.separator\n\nlunr.QueryLexer.lexText = function (lexer) {\n while (true) {\n var char = lexer.next()\n\n if (char == lunr.QueryLexer.EOS) {\n return lunr.QueryLexer.lexEOS\n }\n\n // Escape character is '\\'\n if (char.charCodeAt(0) == 92) {\n lexer.escapeCharacter()\n continue\n }\n\n if (char == \":\") {\n return lunr.QueryLexer.lexField\n }\n\n if (char == \"~\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexEditDistance\n }\n\n if (char == \"^\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexBoost\n }\n\n // \"+\" indicates term presence is required\n // checking for length to ensure that only\n // leading \"+\" are considered\n if (char == \"+\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n // \"-\" indicates term presence is prohibited\n // checking for length to ensure that only\n // leading \"-\" are considered\n if (char == \"-\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n if (char.match(lunr.QueryLexer.termSeparator)) {\n return lunr.QueryLexer.lexTerm\n }\n }\n}\n\nlunr.QueryParser = function (str, query) {\n this.lexer = new lunr.QueryLexer (str)\n this.query = query\n this.currentClause = {}\n this.lexemeIdx = 0\n}\n\nlunr.QueryParser.prototype.parse = function () {\n this.lexer.run()\n this.lexemes = this.lexer.lexemes\n\n var state = lunr.QueryParser.parseClause\n\n while (state) {\n state = state(this)\n }\n\n return this.query\n}\n\nlunr.QueryParser.prototype.peekLexeme = function () {\n return this.lexemes[this.lexemeIdx]\n}\n\nlunr.QueryParser.prototype.consumeLexeme = function () {\n var lexeme = this.peekLexeme()\n this.lexemeIdx += 1\n return lexeme\n}\n\nlunr.QueryParser.prototype.nextClause = function () {\n var completedClause = this.currentClause\n this.query.clause(completedClause)\n this.currentClause = {}\n}\n\nlunr.QueryParser.parseClause = function (parser) {\n var lexeme = parser.peekLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.type) {\n case lunr.QueryLexer.PRESENCE:\n return lunr.QueryParser.parsePresence\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expected either a field or a term, found \" + lexeme.type\n\n if (lexeme.str.length >= 1) {\n errorMessage += \" with value '\" + lexeme.str + \"'\"\n }\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n}\n\nlunr.QueryParser.parsePresence = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.str) {\n case \"-\":\n parser.currentClause.presence = lunr.Query.presence.PROHIBITED\n break\n case \"+\":\n parser.currentClause.presence = lunr.Query.presence.REQUIRED\n break\n default:\n var errorMessage = \"unrecognised presence operator'\" + lexeme.str + \"'\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term or field, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term or field, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseField = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n if (parser.query.allFields.indexOf(lexeme.str) == -1) {\n var possibleFields = parser.query.allFields.map(function (f) { return \"'\" + f + \"'\" }).join(', '),\n errorMessage = \"unrecognised field '\" + lexeme.str + \"', possible fields: \" + possibleFields\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.fields = [lexeme.str]\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseTerm = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n parser.currentClause.term = lexeme.str.toLowerCase()\n\n if (lexeme.str.indexOf(\"*\") != -1) {\n parser.currentClause.usePipeline = false\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseEditDistance = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var editDistance = parseInt(lexeme.str, 10)\n\n if (isNaN(editDistance)) {\n var errorMessage = \"edit distance must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.editDistance = editDistance\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseBoost = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var boost = parseInt(lexeme.str, 10)\n\n if (isNaN(boost)) {\n var errorMessage = \"boost must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.boost = boost\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\n /**\n * export the module via AMD, CommonJS or as a browser global\n * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js\n */\n ;(function (root, factory) {\n if (true) {\n // AMD. Register as an anonymous module.\n !(__WEBPACK_AMD_DEFINE_FACTORY__ = (factory),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?\n\t\t(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :\n\t\t__WEBPACK_AMD_DEFINE_FACTORY__),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))\n } else {}\n }(this, function () {\n /**\n * Just return a value to define the module export.\n * This example returns an object, but the module\n * can return a function as the exported value.\n */\n return lunr\n }))\n})();\n\n\n//# sourceURL=webpack:///../node_modules/lunr/lunr.js?"); + +/***/ }), + +/***/ "./default/assets/css/main.sass": +/*!**************************************!*\ + !*** ./default/assets/css/main.sass ***! + \**************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack:///./default/assets/css/main.sass?"); + +/***/ }), + +/***/ "./default/assets/js/src/bootstrap.ts": +/*!********************************************!*\ + !*** ./default/assets/js/src/bootstrap.ts ***! + \********************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./typedoc/Application */ \"./default/assets/js/src/typedoc/Application.ts\");\n/* harmony import */ var _typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./typedoc/components/MenuHighlight */ \"./default/assets/js/src/typedoc/components/MenuHighlight.ts\");\n/* harmony import */ var _typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./typedoc/components/Search */ \"./default/assets/js/src/typedoc/components/Search.ts\");\n/* harmony import */ var _typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./typedoc/components/Signature */ \"./default/assets/js/src/typedoc/components/Signature.ts\");\n/* harmony import */ var _typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./typedoc/components/Toggle */ \"./default/assets/js/src/typedoc/components/Toggle.ts\");\n/* harmony import */ var _typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./typedoc/components/Filter */ \"./default/assets/js/src/typedoc/components/Filter.ts\");\n/* harmony import */ var _css_main_sass__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ../../css/main.sass */ \"./default/assets/css/main.sass\");\n\n\n\n\n\n\n\n(0,_typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__.initSearch)();\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__.MenuHighlight, \".menu-highlight\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__.Signature, \".tsd-signatures\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__.Toggle, \"a[data-toggle]\");\nif (_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter.isSupported()) {\n (0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter, \"#tsd-filter\");\n}\nelse {\n document.documentElement.classList.add(\"no-filter\");\n}\nvar app = new _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.Application();\nObject.defineProperty(window, \"app\", { value: app });\n\n\n//# sourceURL=webpack:///./default/assets/js/src/bootstrap.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/Application.ts": +/*!******************************************************!*\ + !*** ./default/assets/js/src/typedoc/Application.ts ***! + \******************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"registerComponent\": () => /* binding */ registerComponent,\n/* harmony export */ \"Application\": () => /* binding */ Application\n/* harmony export */ });\n/**\n * List of all known components.\n */\nvar components = [];\n/**\n * Register a new component.\n */\nfunction registerComponent(constructor, selector) {\n components.push({\n selector: selector,\n constructor: constructor,\n });\n}\n/**\n * TypeDoc application class.\n */\nvar Application = /** @class */ (function () {\n /**\n * Create a new Application instance.\n */\n function Application() {\n this.createComponents(document.body);\n }\n /**\n * Create all components beneath the given jQuery element.\n */\n Application.prototype.createComponents = function (context) {\n components.forEach(function (c) {\n context.querySelectorAll(c.selector).forEach(function (el) {\n if (!el.dataset.hasInstance) {\n new c.constructor({ el: el });\n el.dataset.hasInstance = String(true);\n }\n });\n });\n };\n return Application;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Application.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/Component.ts": +/*!****************************************************!*\ + !*** ./default/assets/js/src/typedoc/Component.ts ***! + \****************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Component\": () => /* binding */ Component\n/* harmony export */ });\n/**\n * TypeDoc component class.\n */\nvar Component = /** @class */ (function () {\n function Component(options) {\n this.el = options.el;\n }\n return Component;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Component.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/EventTarget.ts": +/*!******************************************************!*\ + !*** ./default/assets/js/src/typedoc/EventTarget.ts ***! + \******************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"EventTarget\": () => /* binding */ EventTarget\n/* harmony export */ });\n/**\n * TypeDoc event target class.\n */\nvar EventTarget = /** @class */ (function () {\n function EventTarget() {\n this.listeners = {};\n }\n EventTarget.prototype.addEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n this.listeners[type] = [];\n }\n this.listeners[type].push(callback);\n };\n EventTarget.prototype.removeEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n return;\n }\n var stack = this.listeners[type];\n for (var i = 0, l = stack.length; i < l; i++) {\n if (stack[i] === callback) {\n stack.splice(i, 1);\n return;\n }\n }\n };\n EventTarget.prototype.dispatchEvent = function (event) {\n if (!(event.type in this.listeners)) {\n return true;\n }\n var stack = this.listeners[event.type].slice();\n for (var i = 0, l = stack.length; i < l; i++) {\n stack[i].call(this, event);\n }\n return !event.defaultPrevented;\n };\n return EventTarget;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/EventTarget.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Filter.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Filter.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Filter\": () => /* binding */ Filter\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar FilterItem = /** @class */ (function () {\n function FilterItem(key, value) {\n this.key = key;\n this.value = value;\n this.defaultValue = value;\n this.initialize();\n if (window.localStorage[this.key]) {\n this.setValue(this.fromLocalStorage(window.localStorage[this.key]));\n }\n }\n FilterItem.prototype.initialize = function () { };\n FilterItem.prototype.setValue = function (value) {\n if (this.value == value)\n return;\n var oldValue = this.value;\n this.value = value;\n window.localStorage[this.key] = this.toLocalStorage(value);\n this.handleValueChange(oldValue, value);\n };\n return FilterItem;\n}());\nvar FilterItemCheckbox = /** @class */ (function (_super) {\n __extends(FilterItemCheckbox, _super);\n function FilterItemCheckbox() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemCheckbox.prototype.initialize = function () {\n var _this = this;\n var checkbox = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!checkbox)\n return;\n this.checkbox = checkbox;\n this.checkbox.addEventListener(\"change\", function () {\n _this.setValue(_this.checkbox.checked);\n });\n };\n FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {\n if (!this.checkbox)\n return;\n this.checkbox.checked = this.value;\n document.documentElement.classList.toggle(\"toggle-\" + this.key, this.value != this.defaultValue);\n };\n FilterItemCheckbox.prototype.fromLocalStorage = function (value) {\n return value == \"true\";\n };\n FilterItemCheckbox.prototype.toLocalStorage = function (value) {\n return value ? \"true\" : \"false\";\n };\n return FilterItemCheckbox;\n}(FilterItem));\nvar FilterItemSelect = /** @class */ (function (_super) {\n __extends(FilterItemSelect, _super);\n function FilterItemSelect() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemSelect.prototype.initialize = function () {\n var _this = this;\n document.documentElement.classList.add(\"toggle-\" + this.key + this.value);\n var select = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!select)\n return;\n this.select = select;\n var onActivate = function () {\n _this.select.classList.add(\"active\");\n };\n var onDeactivate = function () {\n _this.select.classList.remove(\"active\");\n };\n this.select.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, onActivate);\n this.select.addEventListener(\"mouseover\", onActivate);\n this.select.addEventListener(\"mouseleave\", onDeactivate);\n this.select.querySelectorAll(\"li\").forEach(function (el) {\n el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n select.classList.remove(\"active\");\n _this.setValue(e.target.dataset.value || \"\");\n });\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n if (_this.select.contains(e.target))\n return;\n _this.select.classList.remove(\"active\");\n });\n };\n FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {\n this.select.querySelectorAll(\"li.selected\").forEach(function (el) {\n el.classList.remove(\"selected\");\n });\n var selected = this.select.querySelector('li[data-value=\"' + newValue + '\"]');\n var label = this.select.querySelector(\".tsd-select-label\");\n if (selected && label) {\n selected.classList.add(\"selected\");\n label.textContent = selected.textContent;\n }\n document.documentElement.classList.remove(\"toggle-\" + oldValue);\n document.documentElement.classList.add(\"toggle-\" + newValue);\n };\n FilterItemSelect.prototype.fromLocalStorage = function (value) {\n return value;\n };\n FilterItemSelect.prototype.toLocalStorage = function (value) {\n return value;\n };\n return FilterItemSelect;\n}(FilterItem));\nvar Filter = /** @class */ (function (_super) {\n __extends(Filter, _super);\n function Filter(options) {\n var _this = _super.call(this, options) || this;\n _this.optionVisibility = new FilterItemSelect(\"visibility\", \"private\");\n _this.optionInherited = new FilterItemCheckbox(\"inherited\", true);\n _this.optionExternals = new FilterItemCheckbox(\"externals\", true);\n return _this;\n }\n Filter.isSupported = function () {\n try {\n return typeof window.localStorage != \"undefined\";\n }\n catch (e) {\n return false;\n }\n };\n return Filter;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Filter.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/MenuHighlight.ts": +/*!*******************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/MenuHighlight.ts ***! + \*******************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"MenuHighlight\": () => /* binding */ MenuHighlight\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Manages the sticky state of the navigation and moves the highlight\n * to the current navigation item.\n */\nvar MenuHighlight = /** @class */ (function (_super) {\n __extends(MenuHighlight, _super);\n /**\n * Create a new MenuHighlight instance.\n *\n * @param options Backbone view constructor options.\n */\n function MenuHighlight(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of all discovered anchors.\n */\n _this.anchors = [];\n /**\n * Index of the currently highlighted anchor.\n */\n _this.index = -1;\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"resize\", function () { return _this.onResize(); });\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"scroll\", function (e) { return _this.onScroll(e); });\n _this.createAnchors();\n return _this;\n }\n /**\n * Find all anchors on the current page.\n */\n MenuHighlight.prototype.createAnchors = function () {\n var _this = this;\n var base = window.location.href;\n if (base.indexOf(\"#\") != -1) {\n base = base.substr(0, base.indexOf(\"#\"));\n }\n this.el.querySelectorAll(\"a\").forEach(function (el) {\n var href = el.href;\n if (href.indexOf(\"#\") == -1)\n return;\n if (href.substr(0, base.length) != base)\n return;\n var hash = href.substr(href.indexOf(\"#\") + 1);\n var anchor = document.querySelector(\"a.tsd-anchor[name=\" + hash + \"]\");\n var link = el.parentNode;\n if (!anchor || !link)\n return;\n _this.anchors.push({\n link: link,\n anchor: anchor,\n position: 0,\n });\n });\n this.onResize();\n };\n /**\n * Triggered after the viewport was resized.\n */\n MenuHighlight.prototype.onResize = function () {\n var anchor;\n for (var index = 0, count = this.anchors.length; index < count; index++) {\n anchor = this.anchors[index];\n var rect = anchor.anchor.getBoundingClientRect();\n anchor.position = rect.top + document.body.scrollTop;\n }\n this.anchors.sort(function (a, b) {\n return a.position - b.position;\n });\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.scrollTop,\n },\n });\n this.onScroll(event);\n };\n /**\n * Triggered after the viewport was scrolled.\n *\n * @param event The custom event with the current vertical scroll position.\n */\n MenuHighlight.prototype.onScroll = function (event) {\n var scrollTop = event.detail.scrollTop + 5;\n var anchors = this.anchors;\n var count = anchors.length - 1;\n var index = this.index;\n while (index > -1 && anchors[index].position > scrollTop) {\n index -= 1;\n }\n while (index < count && anchors[index + 1].position < scrollTop) {\n index += 1;\n }\n if (this.index != index) {\n if (this.index > -1)\n this.anchors[this.index].link.classList.remove(\"focus\");\n this.index = index;\n if (this.index > -1)\n this.anchors[this.index].link.classList.add(\"focus\");\n }\n };\n return MenuHighlight;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/MenuHighlight.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Search.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Search.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"initSearch\": () => /* binding */ initSearch\n/* harmony export */ });\n/* harmony import */ var _utils_debounce__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../utils/debounce */ \"./default/assets/js/src/typedoc/utils/debounce.ts\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! lunr */ \"../node_modules/lunr/lunr.js\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(lunr__WEBPACK_IMPORTED_MODULE_1__);\n\n\nfunction initSearch() {\n var searchEl = document.getElementById(\"tsd-search\");\n if (!searchEl)\n return;\n var searchScript = document.getElementById(\"search-script\");\n if (searchScript) {\n searchScript.addEventListener(\"error\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"failure\");\n });\n searchScript.addEventListener(\"load\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n });\n }\n searchEl.classList.add(\"loading\");\n var field = document.querySelector(\"#tsd-search-field\");\n var results = document.querySelector(\".results\");\n if (!field || !results) {\n throw new Error(\"The input field or the result list wrapper was not found\");\n }\n field.addEventListener(\"focus\", function () { return searchEl.classList.add(\"has-focus\"); });\n field.addEventListener(\"blur\", function () {\n // Delay a bit so that mouse clicks don't get swallowed\n setTimeout(function () { return searchEl.classList.remove(\"has-focus\"); }, 100);\n });\n var state = {\n base: searchEl.dataset.base + \"/\",\n };\n bindEvents(searchEl, results, field, state);\n}\nfunction bindEvents(searchEl, results, field, state) {\n field.addEventListener(\"input\", (0,_utils_debounce__WEBPACK_IMPORTED_MODULE_0__.debounce)(function () {\n updateResults(searchEl, results, field, state);\n }, 200));\n var preventPress = false;\n field.addEventListener(\"keydown\", function (e) {\n preventPress = true;\n if (e.key == \"Enter\") {\n gotoCurrentResult(results, field);\n }\n else if (e.key == \"Escape\") {\n field.blur();\n }\n else if (e.key == \"ArrowUp\") {\n setCurrentResult(results, -1);\n }\n else if (e.key === \"ArrowDown\") {\n setCurrentResult(results, 1);\n }\n else {\n preventPress = false;\n }\n });\n field.addEventListener(\"keypress\", function (e) {\n if (preventPress)\n e.preventDefault();\n });\n /**\n * Start searching by pressing slash.\n */\n document.body.addEventListener(\"keydown\", function (e) {\n if (e.altKey || e.ctrlKey || e.metaKey)\n return;\n if (!field.matches(\":focus\") && e.key === \"/\") {\n field.focus();\n e.preventDefault();\n }\n });\n}\nfunction checkIndex(state, searchEl) {\n if (state.index)\n return;\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n state.data = window.searchData;\n state.index = lunr__WEBPACK_IMPORTED_MODULE_1__.Index.load(window.searchData.index);\n }\n}\nfunction updateResults(searchEl, results, query, state) {\n checkIndex(state, searchEl);\n // Don't clear results if loading state is not ready,\n // because loading or error message can be removed.\n if (!state.index || !state.data)\n return;\n results.textContent = \"\";\n var searchText = query.value.trim();\n // Perform a wildcard search\n var res = state.index.search(\"*\" + searchText + \"*\");\n for (var i = 0, c = Math.min(10, res.length); i < c; i++) {\n var row = state.data.rows[Number(res[i].ref)];\n // Bold the matched part of the query in the search results\n var name_1 = boldMatches(row.name, searchText);\n if (row.parent) {\n name_1 = \"\" + boldMatches(row.parent, searchText) + \".\" + name_1;\n }\n var item = document.createElement(\"li\");\n item.classList.value = row.classes;\n var anchor = document.createElement(\"a\");\n anchor.href = state.base + row.url;\n anchor.classList.add(\"tsd-kind-icon\");\n anchor.innerHTML = name_1;\n item.append(anchor);\n results.appendChild(item);\n }\n}\n/**\n * Move the highlight within the result set.\n */\nfunction setCurrentResult(results, dir) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(dir == 1 ? \"li:first-child\" : \"li:last-child\");\n if (current) {\n current.classList.add(\"current\");\n }\n }\n else {\n var rel = dir == 1\n ? current.nextElementSibling\n : current.previousElementSibling;\n if (rel) {\n current.classList.remove(\"current\");\n rel.classList.add(\"current\");\n }\n }\n}\n/**\n * Navigate to the highlighted result.\n */\nfunction gotoCurrentResult(results, field) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(\"li:first-child\");\n }\n if (current) {\n var link = current.querySelector(\"a\");\n if (link) {\n window.location.href = link.href;\n }\n field.blur();\n }\n}\nfunction boldMatches(text, search) {\n if (search === \"\") {\n return text;\n }\n var lowerText = text.toLocaleLowerCase();\n var lowerSearch = search.toLocaleLowerCase();\n var parts = [];\n var lastIndex = 0;\n var index = lowerText.indexOf(lowerSearch);\n while (index != -1) {\n parts.push(escapeHtml(text.substring(lastIndex, index)), \"\" + escapeHtml(text.substring(index, index + lowerSearch.length)) + \"\");\n lastIndex = index + lowerSearch.length;\n index = lowerText.indexOf(lowerSearch, lastIndex);\n }\n parts.push(escapeHtml(text.substring(lastIndex)));\n return parts.join(\"\");\n}\nvar SPECIAL_HTML = {\n \"&\": \"&\",\n \"<\": \"<\",\n \">\": \">\",\n \"'\": \"'\",\n '\"': \""\",\n};\nfunction escapeHtml(text) {\n return text.replace(/[&<>\"'\"]/g, function (match) { return SPECIAL_HTML[match]; });\n}\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Search.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Signature.ts": +/*!***************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Signature.ts ***! + \***************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Signature\": () => /* binding */ Signature\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Holds a signature and its description.\n */\nvar SignatureGroup = /** @class */ (function () {\n /**\n * Create a new SignatureGroup instance.\n *\n * @param signature The target signature.\n * @param description The description for the signature.\n */\n function SignatureGroup(signature, description) {\n this.signature = signature;\n this.description = description;\n }\n /**\n * Add the given class to all elements of the group.\n *\n * @param className The class name to add.\n */\n SignatureGroup.prototype.addClass = function (className) {\n this.signature.classList.add(className);\n this.description.classList.add(className);\n return this;\n };\n /**\n * Remove the given class from all elements of the group.\n *\n * @param className The class name to remove.\n */\n SignatureGroup.prototype.removeClass = function (className) {\n this.signature.classList.remove(className);\n this.description.classList.remove(className);\n return this;\n };\n return SignatureGroup;\n}());\n/**\n * Controls the tab like behaviour of methods and functions with multiple signatures.\n */\nvar Signature = /** @class */ (function (_super) {\n __extends(Signature, _super);\n /**\n * Create a new Signature instance.\n *\n * @param options Backbone view constructor options.\n */\n function Signature(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of found signature groups.\n */\n _this.groups = [];\n /**\n * The index of the currently displayed signature.\n */\n _this.index = -1;\n _this.createGroups();\n if (_this.container) {\n _this.el.classList.add(\"active\");\n Array.from(_this.el.children).forEach(function (signature) {\n signature.addEventListener(\"touchstart\", function (event) {\n return _this.onClick(event);\n });\n signature.addEventListener(\"click\", function (event) {\n return _this.onClick(event);\n });\n });\n _this.container.classList.add(\"active\");\n _this.setIndex(0);\n }\n return _this;\n }\n /**\n * Set the index of the active signature.\n *\n * @param index The index of the signature to activate.\n */\n Signature.prototype.setIndex = function (index) {\n if (index < 0)\n index = 0;\n if (index > this.groups.length - 1)\n index = this.groups.length - 1;\n if (this.index == index)\n return;\n var to = this.groups[index];\n if (this.index > -1) {\n var from_1 = this.groups[this.index];\n from_1.removeClass(\"current\").addClass(\"fade-out\");\n to.addClass(\"current\");\n to.addClass(\"fade-in\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n setTimeout(function () {\n from_1.removeClass(\"fade-out\");\n to.removeClass(\"fade-in\");\n }, 300);\n }\n else {\n to.addClass(\"current\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n }\n this.index = index;\n };\n /**\n * Find all signature/description groups.\n */\n Signature.prototype.createGroups = function () {\n var signatures = this.el.children;\n if (signatures.length < 2)\n return;\n this.container = this.el.nextElementSibling;\n var descriptions = this.container.children;\n this.groups = [];\n for (var index = 0; index < signatures.length; index++) {\n this.groups.push(new SignatureGroup(signatures[index], descriptions[index]));\n }\n };\n /**\n * Triggered when the user clicks onto a signature header.\n *\n * @param e The related event object.\n */\n Signature.prototype.onClick = function (e) {\n var _this = this;\n this.groups.forEach(function (group, index) {\n if (group.signature === e.currentTarget) {\n _this.setIndex(index);\n }\n });\n };\n return Signature;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Signature.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Toggle.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Toggle.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Toggle\": () => /* binding */ Toggle\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar Toggle = /** @class */ (function (_super) {\n __extends(Toggle, _super);\n function Toggle(options) {\n var _this = _super.call(this, options) || this;\n _this.className = _this.el.dataset.toggle || \"\";\n _this.el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) { return _this.onPointerUp(e); });\n _this.el.addEventListener(\"click\", function (e) { return e.preventDefault(); });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n return _this.onDocumentPointerDown(e);\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n return _this.onDocumentPointerUp(e);\n });\n return _this;\n }\n Toggle.prototype.setActive = function (value) {\n if (this.active == value)\n return;\n this.active = value;\n document.documentElement.classList.toggle(\"has-\" + this.className, value);\n this.el.classList.toggle(\"active\", value);\n var transition = (this.active ? \"to-has-\" : \"from-has-\") + this.className;\n document.documentElement.classList.add(transition);\n setTimeout(function () { return document.documentElement.classList.remove(transition); }, 500);\n };\n Toggle.prototype.onPointerUp = function (event) {\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n this.setActive(true);\n event.preventDefault();\n };\n Toggle.prototype.onDocumentPointerDown = function (e) {\n if (this.active) {\n if (e.target.closest(\".col-menu, .tsd-filter-group\")) {\n return;\n }\n this.setActive(false);\n }\n };\n Toggle.prototype.onDocumentPointerUp = function (e) {\n var _this = this;\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n if (this.active) {\n if (e.target.closest(\".col-menu\")) {\n var link = e.target.closest(\"a\");\n if (link) {\n var href = window.location.href;\n if (href.indexOf(\"#\") != -1) {\n href = href.substr(0, href.indexOf(\"#\"));\n }\n if (link.href.substr(0, href.length) == href) {\n setTimeout(function () { return _this.setActive(false); }, 250);\n }\n }\n }\n }\n };\n return Toggle;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Toggle.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/services/Viewport.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/services/Viewport.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Viewport\": () => /* binding */ Viewport\n/* harmony export */ });\n/* harmony import */ var _EventTarget__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../EventTarget */ \"./default/assets/js/src/typedoc/EventTarget.ts\");\n/* harmony import */ var _utils_trottle__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/trottle */ \"./default/assets/js/src/typedoc/utils/trottle.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * A global service that monitors the window size and scroll position.\n */\nvar Viewport = /** @class */ (function (_super) {\n __extends(Viewport, _super);\n /**\n * Create new Viewport instance.\n */\n function Viewport() {\n var _this = _super.call(this) || this;\n /**\n * The current scroll position.\n */\n _this.scrollTop = 0;\n /**\n * The previous scrollTop.\n */\n _this.lastY = 0;\n /**\n * The width of the window.\n */\n _this.width = 0;\n /**\n * The height of the window.\n */\n _this.height = 0;\n /**\n * Boolean indicating whether the toolbar is shown.\n */\n _this.showToolbar = true;\n _this.toolbar = (document.querySelector(\".tsd-page-toolbar\"));\n _this.secondaryNav = (document.querySelector(\".tsd-navigation.secondary\"));\n window.addEventListener(\"scroll\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onScroll(); }, 10));\n window.addEventListener(\"resize\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onResize(); }, 10));\n _this.onResize();\n _this.onScroll();\n return _this;\n }\n /**\n * Trigger a resize event.\n */\n Viewport.prototype.triggerResize = function () {\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the size of the window has changed.\n */\n Viewport.prototype.onResize = function () {\n this.width = window.innerWidth || 0;\n this.height = window.innerHeight || 0;\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the user scrolled the viewport.\n */\n Viewport.prototype.onScroll = function () {\n this.scrollTop = window.scrollY || 0;\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: this.scrollTop,\n },\n });\n this.dispatchEvent(event);\n this.hideShowToolbar();\n };\n /**\n * Handle hiding/showing of the toolbar.\n */\n Viewport.prototype.hideShowToolbar = function () {\n var isShown = this.showToolbar;\n this.showToolbar = this.lastY >= this.scrollTop || this.scrollTop === 0;\n if (isShown !== this.showToolbar) {\n this.toolbar.classList.toggle(\"tsd-page-toolbar--hide\");\n this.secondaryNav.classList.toggle(\"tsd-navigation--toolbar-hide\");\n }\n this.lastY = this.scrollTop;\n };\n Viewport.instance = new Viewport();\n return Viewport;\n}(_EventTarget__WEBPACK_IMPORTED_MODULE_0__.EventTarget));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/services/Viewport.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/debounce.ts": +/*!*********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/debounce.ts ***! + \*********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"debounce\": () => /* binding */ debounce\n/* harmony export */ });\nvar debounce = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var timeout;\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n clearTimeout(timeout);\n timeout = setTimeout(function () { return fn(args); }, wait);\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/debounce.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/pointer.ts": +/*!********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/pointer.ts ***! + \********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"pointerDown\": () => /* binding */ pointerDown,\n/* harmony export */ \"pointerMove\": () => /* binding */ pointerMove,\n/* harmony export */ \"pointerUp\": () => /* binding */ pointerUp,\n/* harmony export */ \"pointerDownPosition\": () => /* binding */ pointerDownPosition,\n/* harmony export */ \"preventNextClick\": () => /* binding */ preventNextClick,\n/* harmony export */ \"isPointerDown\": () => /* binding */ isPointerDown,\n/* harmony export */ \"isPointerTouch\": () => /* binding */ isPointerTouch,\n/* harmony export */ \"hasPointerMoved\": () => /* binding */ hasPointerMoved,\n/* harmony export */ \"isMobile\": () => /* binding */ isMobile\n/* harmony export */ });\n/**\n * Event name of the pointer down event.\n */\nvar pointerDown = \"mousedown\";\n/**\n * Event name of the pointer move event.\n */\nvar pointerMove = \"mousemove\";\n/**\n * Event name of the pointer up event.\n */\nvar pointerUp = \"mouseup\";\n/**\n * Position the pointer was pressed at.\n */\nvar pointerDownPosition = { x: 0, y: 0 };\n/**\n * Should the next click on the document be supressed?\n */\nvar preventNextClick = false;\n/**\n * Is the pointer down?\n */\nvar isPointerDown = false;\n/**\n * Is the pointer a touch point?\n */\nvar isPointerTouch = false;\n/**\n * Did the pointer move since the last down event?\n */\nvar hasPointerMoved = false;\n/**\n * Is the user agent a mobile agent?\n */\nvar isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);\ndocument.documentElement.classList.add(isMobile ? \"is-mobile\" : \"not-mobile\");\nif (isMobile && \"ontouchstart\" in document.documentElement) {\n isPointerTouch = true;\n pointerDown = \"touchstart\";\n pointerMove = \"touchmove\";\n pointerUp = \"touchend\";\n}\ndocument.addEventListener(pointerDown, function (e) {\n isPointerDown = true;\n hasPointerMoved = false;\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n pointerDownPosition.y = t.pageY || 0;\n pointerDownPosition.x = t.pageX || 0;\n});\ndocument.addEventListener(pointerMove, function (e) {\n if (!isPointerDown)\n return;\n if (!hasPointerMoved) {\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n var x = pointerDownPosition.x - (t.pageX || 0);\n var y = pointerDownPosition.y - (t.pageY || 0);\n hasPointerMoved = Math.sqrt(x * x + y * y) > 10;\n }\n});\ndocument.addEventListener(pointerUp, function () {\n isPointerDown = false;\n});\ndocument.addEventListener(\"click\", function (e) {\n if (preventNextClick) {\n e.preventDefault();\n e.stopImmediatePropagation();\n preventNextClick = false;\n }\n});\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/pointer.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/trottle.ts": +/*!********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/trottle.ts ***! + \********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"throttle\": () => /* binding */ throttle\n/* harmony export */ });\nvar throttle = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var time = Date.now();\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n if (time + wait - Date.now() < 0) {\n fn.apply(void 0, args);\n time = Date.now();\n }\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/trottle.ts?"); + +/***/ }) + +/******/ }); +/************************************************************************/ +/******/ // The module cache +/******/ var __webpack_module_cache__ = {}; +/******/ +/******/ // The require function +/******/ function __webpack_require__(moduleId) { +/******/ // Check if module is in cache +/******/ if(__webpack_module_cache__[moduleId]) { +/******/ return __webpack_module_cache__[moduleId].exports; +/******/ } +/******/ // Create a new module (and put it into the cache) +/******/ var module = __webpack_module_cache__[moduleId] = { +/******/ // no module.id needed +/******/ // no module.loaded needed +/******/ exports: {} +/******/ }; +/******/ +/******/ // Execute the module function +/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__); +/******/ +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } +/******/ +/************************************************************************/ +/******/ /* webpack/runtime/compat get default export */ +/******/ (() => { +/******/ // getDefaultExport function for compatibility with non-harmony modules +/******/ __webpack_require__.n = (module) => { +/******/ var getter = module && module.__esModule ? +/******/ () => module['default'] : +/******/ () => module; +/******/ __webpack_require__.d(getter, { a: getter }); +/******/ return getter; +/******/ }; +/******/ })(); +/******/ +/******/ /* webpack/runtime/define property getters */ +/******/ (() => { +/******/ // define getter functions for harmony exports +/******/ __webpack_require__.d = (exports, definition) => { +/******/ for(var key in definition) { +/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) { +/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] }); +/******/ } +/******/ } +/******/ }; +/******/ })(); +/******/ +/******/ /* webpack/runtime/hasOwnProperty shorthand */ +/******/ (() => { +/******/ __webpack_require__.o = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop) +/******/ })(); +/******/ +/******/ /* webpack/runtime/make namespace object */ +/******/ (() => { +/******/ // define __esModule on exports +/******/ __webpack_require__.r = (exports) => { +/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { +/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); +/******/ } +/******/ Object.defineProperty(exports, '__esModule', { value: true }); +/******/ }; +/******/ })(); +/******/ +/************************************************************************/ +/******/ // startup +/******/ // Load entry module +/******/ __webpack_require__("./default/assets/js/src/bootstrap.ts"); +/******/ // This entry module used 'exports' so it can't be inlined +/******/ })() +; \ No newline at end of file diff --git a/master/assets/js/search.js b/master/assets/js/search.js new file mode 100644 index 000000000..1459efcdf --- /dev/null +++ b/master/assets/js/search.js @@ -0,0 +1 @@ +window.searchData = {"kinds":{"4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","262144":"Accessor"},"rows":[{"id":0,"kind":64,"name":"loadRuffle","url":"modules.html#loadruffle","classes":"tsd-kind-function"},{"id":1,"kind":64,"name":"installPlugin","url":"modules.html#installplugin","classes":"tsd-kind-function"},{"id":2,"kind":32,"name":"FLASH_PLUGIN","url":"modules.html#flash_plugin","classes":"tsd-kind-variable"},{"id":3,"kind":64,"name":"pluginPolyfill","url":"modules.html#pluginpolyfill","classes":"tsd-kind-function"},{"id":4,"kind":64,"name":"polyfill","url":"modules.html#polyfill","classes":"tsd-kind-function"},{"id":5,"kind":128,"name":"PublicAPI","url":"classes/publicapi.html","classes":"tsd-kind-class"},{"id":6,"kind":2048,"name":"negotiate","url":"classes/publicapi.html#negotiate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"PublicAPI"},{"id":7,"kind":512,"name":"constructor","url":"classes/publicapi.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"PublicAPI"},{"id":8,"kind":1024,"name":"config","url":"classes/publicapi.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"PublicAPI"},{"id":9,"kind":262144,"name":"version","url":"classes/publicapi.html#version","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"PublicAPI"},{"id":10,"kind":2048,"name":"registerSource","url":"classes/publicapi.html#registersource","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PublicAPI"},{"id":11,"kind":2048,"name":"newestSourceName","url":"classes/publicapi.html#newestsourcename","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PublicAPI"},{"id":12,"kind":2048,"name":"init","url":"classes/publicapi.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PublicAPI"},{"id":13,"kind":2048,"name":"newest","url":"classes/publicapi.html#newest","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PublicAPI"},{"id":14,"kind":2048,"name":"satisfying","url":"classes/publicapi.html#satisfying","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PublicAPI"},{"id":15,"kind":2048,"name":"localCompatible","url":"classes/publicapi.html#localcompatible","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PublicAPI"},{"id":16,"kind":2048,"name":"local","url":"classes/publicapi.html#local","classes":"tsd-kind-method tsd-parent-kind-class","parent":"PublicAPI"},{"id":17,"kind":64,"name":"publicPath","url":"modules.html#publicpath","classes":"tsd-kind-function"},{"id":18,"kind":64,"name":"lookupElement","url":"modules.html#lookupelement","classes":"tsd-kind-function"},{"id":19,"kind":64,"name":"registerElement","url":"modules.html#registerelement","classes":"tsd-kind-function"},{"id":20,"kind":128,"name":"RuffleEmbed","url":"classes/ruffleembed.html","classes":"tsd-kind-class"},{"id":21,"kind":2048,"name":"isInterdictable","url":"classes/ruffleembed.html#isinterdictable","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RuffleEmbed"},{"id":22,"kind":2048,"name":"fromNativeEmbedElement","url":"classes/ruffleembed.html#fromnativeembedelement","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RuffleEmbed"},{"id":23,"kind":512,"name":"constructor","url":"classes/ruffleembed.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":24,"kind":1024,"name":"allowScriptAccess","url":"classes/ruffleembed.html#allowscriptaccess","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":25,"kind":1024,"name":"config","url":"classes/ruffleembed.html#config","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":26,"kind":2048,"name":"load","url":"classes/ruffleembed.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":27,"kind":2048,"name":"play","url":"classes/ruffleembed.html#play","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":28,"kind":262144,"name":"fullscreenEnabled","url":"classes/ruffleembed.html#fullscreenenabled","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":29,"kind":262144,"name":"isFullscreen","url":"classes/ruffleembed.html#isfullscreen","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":30,"kind":2048,"name":"enterFullscreen","url":"classes/ruffleembed.html#enterfullscreen","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":31,"kind":2048,"name":"exitFullscreen","url":"classes/ruffleembed.html#exitfullscreen","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":32,"kind":2048,"name":"pause","url":"classes/ruffleembed.html#pause","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":33,"kind":262144,"name":"traceObserver","url":"classes/ruffleembed.html#traceobserver","classes":"tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":34,"kind":2048,"name":"panic","url":"classes/ruffleembed.html#panic","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":35,"kind":2048,"name":"displayMessage","url":"classes/ruffleembed.html#displaymessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":36,"kind":1024,"name":"webkitRequestFullScreen","url":"classes/ruffleembed.html#webkitrequestfullscreen","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"RuffleEmbed"},{"id":37,"kind":64,"name":"copyToAudioBuffer","url":"modules.html#copytoaudiobuffer","classes":"tsd-kind-function"},{"id":38,"kind":128,"name":"RuffleObject","url":"classes/ruffleobject.html","classes":"tsd-kind-class"},{"id":39,"kind":2048,"name":"isInterdictable","url":"classes/ruffleobject.html#isinterdictable","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RuffleObject"},{"id":40,"kind":2048,"name":"fromNativeObjectElement","url":"classes/ruffleobject.html#fromnativeobjectelement","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"RuffleObject"},{"id":41,"kind":512,"name":"constructor","url":"classes/ruffleobject.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":42,"kind":1024,"name":"allowScriptAccess","url":"classes/ruffleobject.html#allowscriptaccess","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":43,"kind":1024,"name":"config","url":"classes/ruffleobject.html#config","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":44,"kind":2048,"name":"load","url":"classes/ruffleobject.html#load","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":45,"kind":2048,"name":"play","url":"classes/ruffleobject.html#play","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":46,"kind":262144,"name":"fullscreenEnabled","url":"classes/ruffleobject.html#fullscreenenabled","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":47,"kind":262144,"name":"isFullscreen","url":"classes/ruffleobject.html#isfullscreen","classes":"tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":48,"kind":2048,"name":"enterFullscreen","url":"classes/ruffleobject.html#enterfullscreen","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":49,"kind":2048,"name":"exitFullscreen","url":"classes/ruffleobject.html#exitfullscreen","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":50,"kind":2048,"name":"pause","url":"classes/ruffleobject.html#pause","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":51,"kind":262144,"name":"traceObserver","url":"classes/ruffleobject.html#traceobserver","classes":"tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":52,"kind":2048,"name":"panic","url":"classes/ruffleobject.html#panic","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":53,"kind":2048,"name":"displayMessage","url":"classes/ruffleobject.html#displaymessage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":54,"kind":1024,"name":"webkitRequestFullScreen","url":"classes/ruffleobject.html#webkitrequestfullscreen","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"RuffleObject"},{"id":55,"kind":64,"name":"isSwfFilename","url":"modules.html#isswffilename","classes":"tsd-kind-function"},{"id":56,"kind":32,"name":"FLASH_MIMETYPE","url":"modules.html#flash_mimetype","classes":"tsd-kind-variable"},{"id":57,"kind":32,"name":"FUTURESPLASH_MIMETYPE","url":"modules.html#futuresplash_mimetype","classes":"tsd-kind-variable"},{"id":58,"kind":32,"name":"FLASH7_AND_8_MIMETYPE","url":"modules.html#flash7_and_8_mimetype","classes":"tsd-kind-variable"},{"id":59,"kind":32,"name":"FLASH_MOVIE_MIMETYPE","url":"modules.html#flash_movie_mimetype","classes":"tsd-kind-variable"},{"id":60,"kind":32,"name":"FLASH_ACTIVEX_CLASSID","url":"modules.html#flash_activex_classid","classes":"tsd-kind-variable"},{"id":61,"kind":128,"name":"RufflePlayer","url":"classes/ruffleplayer.html","classes":"tsd-kind-class"},{"id":62,"kind":512,"name":"constructor","url":"classes/ruffleplayer.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RufflePlayer"},{"id":63,"kind":1024,"name":"allowScriptAccess","url":"classes/ruffleplayer.html#allowscriptaccess","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RufflePlayer"},{"id":64,"kind":1024,"name":"config","url":"classes/ruffleplayer.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RufflePlayer"},{"id":65,"kind":2048,"name":"load","url":"classes/ruffleplayer.html#load","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RufflePlayer"},{"id":66,"kind":2048,"name":"play","url":"classes/ruffleplayer.html#play","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RufflePlayer"},{"id":67,"kind":262144,"name":"fullscreenEnabled","url":"classes/ruffleplayer.html#fullscreenenabled","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"RufflePlayer"},{"id":68,"kind":262144,"name":"isFullscreen","url":"classes/ruffleplayer.html#isfullscreen","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"RufflePlayer"},{"id":69,"kind":2048,"name":"enterFullscreen","url":"classes/ruffleplayer.html#enterfullscreen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RufflePlayer"},{"id":70,"kind":2048,"name":"exitFullscreen","url":"classes/ruffleplayer.html#exitfullscreen","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RufflePlayer"},{"id":71,"kind":2048,"name":"pause","url":"classes/ruffleplayer.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RufflePlayer"},{"id":72,"kind":262144,"name":"traceObserver","url":"classes/ruffleplayer.html#traceobserver","classes":"tsd-kind-set-signature tsd-parent-kind-class","parent":"RufflePlayer"},{"id":73,"kind":2048,"name":"panic","url":"classes/ruffleplayer.html#panic","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RufflePlayer"},{"id":74,"kind":2048,"name":"displayMessage","url":"classes/ruffleplayer.html#displaymessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RufflePlayer"},{"id":75,"kind":1024,"name":"webkitRequestFullScreen","url":"classes/ruffleplayer.html#webkitrequestfullscreen","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RufflePlayer"},{"id":76,"kind":32,"name":"ruffleShadowTemplate","url":"modules.html#ruffleshadowtemplate","classes":"tsd-kind-variable"},{"id":77,"kind":128,"name":"SourceAPI","url":"classes/sourceapi.html","classes":"tsd-kind-class"},{"id":78,"kind":512,"name":"constructor","url":"classes/sourceapi.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"SourceAPI"},{"id":79,"kind":262144,"name":"version","url":"classes/sourceapi.html#version","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"SourceAPI"},{"id":80,"kind":2048,"name":"polyfill","url":"classes/sourceapi.html#polyfill","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SourceAPI"},{"id":81,"kind":2048,"name":"pluginPolyfill","url":"classes/sourceapi.html#pluginpolyfill","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SourceAPI"},{"id":82,"kind":2048,"name":"createPlayer","url":"classes/sourceapi.html#createplayer","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SourceAPI"},{"id":83,"kind":128,"name":"Version","url":"classes/version.html","classes":"tsd-kind-class"},{"id":84,"kind":2048,"name":"fromSemver","url":"classes/version.html#fromsemver","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Version"},{"id":85,"kind":512,"name":"constructor","url":"classes/version.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Version"},{"id":86,"kind":2048,"name":"isCompatibleWith","url":"classes/version.html#iscompatiblewith","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Version"},{"id":87,"kind":2048,"name":"hasPrecedenceOver","url":"classes/version.html#hasprecedenceover","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Version"},{"id":88,"kind":2048,"name":"isEqual","url":"classes/version.html#isequal","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Version"},{"id":89,"kind":2048,"name":"isStableOrCompatiblePrerelease","url":"classes/version.html#isstableorcompatibleprerelease","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Version"},{"id":90,"kind":128,"name":"VersionRange","url":"classes/versionrange.html","classes":"tsd-kind-class"},{"id":91,"kind":2048,"name":"fromRequirementString","url":"classes/versionrange.html#fromrequirementstring","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"VersionRange"},{"id":92,"kind":512,"name":"constructor","url":"classes/versionrange.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"VersionRange"},{"id":93,"kind":1024,"name":"requirements","url":"classes/versionrange.html#requirements","classes":"tsd-kind-property tsd-parent-kind-class","parent":"VersionRange"},{"id":94,"kind":2048,"name":"satisfiedBy","url":"classes/versionrange.html#satisfiedby","classes":"tsd-kind-method tsd-parent-kind-class","parent":"VersionRange"},{"id":95,"kind":256,"name":"Config","url":"interfaces/config.html","classes":"tsd-kind-interface"},{"id":96,"kind":1024,"name":"publicPaths","url":"interfaces/config.html#publicpaths","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Config"},{"id":97,"kind":1024,"name":"publicPath","url":"interfaces/config.html#publicpath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Config"},{"id":98,"kind":1024,"name":"polyfills","url":"interfaces/config.html#polyfills","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Config"},{"id":99,"kind":1024,"name":"parameters","url":"interfaces/config.html#parameters","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Config"},{"id":100,"kind":1024,"name":"autoplay","url":"interfaces/config.html#autoplay","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Config"},{"id":101,"kind":1024,"name":"unmuteOverlay","url":"interfaces/config.html#unmuteoverlay","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Config"},{"id":102,"kind":1024,"name":"upgradeToHttps","url":"interfaces/config.html#upgradetohttps","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Config"},{"id":103,"kind":4,"name":"AutoPlay","url":"enums/autoplay.html","classes":"tsd-kind-enum"},{"id":104,"kind":16,"name":"On","url":"enums/autoplay.html#on","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"AutoPlay"},{"id":105,"kind":16,"name":"Off","url":"enums/autoplay.html#off","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"AutoPlay"},{"id":106,"kind":16,"name":"Auto","url":"enums/autoplay.html#auto","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"AutoPlay"},{"id":107,"kind":4,"name":"UnmuteOverlay","url":"enums/unmuteoverlay.html","classes":"tsd-kind-enum"},{"id":108,"kind":16,"name":"Visible","url":"enums/unmuteoverlay.html#visible","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"UnmuteOverlay"},{"id":109,"kind":16,"name":"Hidden","url":"enums/unmuteoverlay.html#hidden","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"UnmuteOverlay"},{"id":110,"kind":256,"name":"BaseLoadOptions","url":"interfaces/baseloadoptions.html","classes":"tsd-kind-interface"},{"id":111,"kind":1024,"name":"parameters","url":"interfaces/baseloadoptions.html#parameters","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BaseLoadOptions"},{"id":112,"kind":1024,"name":"autoplay","url":"interfaces/baseloadoptions.html#autoplay","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BaseLoadOptions"},{"id":113,"kind":1024,"name":"unmuteOverlay","url":"interfaces/baseloadoptions.html#unmuteoverlay","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BaseLoadOptions"},{"id":114,"kind":1024,"name":"upgradeToHttps","url":"interfaces/baseloadoptions.html#upgradetohttps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BaseLoadOptions"},{"id":115,"kind":256,"name":"URLLoadOptions","url":"interfaces/urlloadoptions.html","classes":"tsd-kind-interface"},{"id":116,"kind":1024,"name":"url","url":"interfaces/urlloadoptions.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"URLLoadOptions"},{"id":117,"kind":1024,"name":"parameters","url":"interfaces/urlloadoptions.html#parameters","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"URLLoadOptions"},{"id":118,"kind":1024,"name":"autoplay","url":"interfaces/urlloadoptions.html#autoplay","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"URLLoadOptions"},{"id":119,"kind":1024,"name":"unmuteOverlay","url":"interfaces/urlloadoptions.html#unmuteoverlay","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"URLLoadOptions"},{"id":120,"kind":1024,"name":"upgradeToHttps","url":"interfaces/urlloadoptions.html#upgradetohttps","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"URLLoadOptions"},{"id":121,"kind":256,"name":"DataLoadOptions","url":"interfaces/dataloadoptions.html","classes":"tsd-kind-interface"},{"id":122,"kind":1024,"name":"data","url":"interfaces/dataloadoptions.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataLoadOptions"},{"id":123,"kind":1024,"name":"parameters","url":"interfaces/dataloadoptions.html#parameters","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DataLoadOptions"},{"id":124,"kind":1024,"name":"autoplay","url":"interfaces/dataloadoptions.html#autoplay","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DataLoadOptions"},{"id":125,"kind":1024,"name":"unmuteOverlay","url":"interfaces/dataloadoptions.html#unmuteoverlay","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DataLoadOptions"},{"id":126,"kind":1024,"name":"upgradeToHttps","url":"interfaces/dataloadoptions.html#upgradetohttps","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DataLoadOptions"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,44.466]],["parent/0",[]],["name/1",[1,44.466]],["parent/1",[]],["name/2",[2,44.466]],["parent/2",[]],["name/3",[3,39.357]],["parent/3",[]],["name/4",[4,39.357]],["parent/4",[]],["name/5",[5,23.263]],["parent/5",[]],["name/6",[6,44.466]],["parent/6",[5,2.075]],["name/7",[7,28.371]],["parent/7",[5,2.075]],["name/8",[8,23.263]],["parent/8",[5,2.075]],["name/9",[9,26.007]],["parent/9",[5,2.075]],["name/10",[10,44.466]],["parent/10",[5,2.075]],["name/11",[11,44.466]],["parent/11",[5,2.075]],["name/12",[12,44.466]],["parent/12",[5,2.075]],["name/13",[13,44.466]],["parent/13",[5,2.075]],["name/14",[14,44.466]],["parent/14",[5,2.075]],["name/15",[15,44.466]],["parent/15",[5,2.075]],["name/16",[16,44.466]],["parent/16",[5,2.075]],["name/17",[17,39.357]],["parent/17",[]],["name/18",[18,44.466]],["parent/18",[]],["name/19",[19,44.466]],["parent/19",[]],["name/20",[20,19.898]],["parent/20",[]],["name/21",[21,39.357]],["parent/21",[20,1.775]],["name/22",[22,44.466]],["parent/22",[20,1.775]],["name/23",[7,28.371]],["parent/23",[20,1.775]],["name/24",[23,35.993]],["parent/24",[20,1.775]],["name/25",[8,23.263]],["parent/25",[20,1.775]],["name/26",[24,35.993]],["parent/26",[20,1.775]],["name/27",[25,35.993]],["parent/27",[20,1.775]],["name/28",[26,35.993]],["parent/28",[20,1.775]],["name/29",[27,35.993]],["parent/29",[20,1.775]],["name/30",[28,35.993]],["parent/30",[20,1.775]],["name/31",[29,35.993]],["parent/31",[20,1.775]],["name/32",[30,35.993]],["parent/32",[20,1.775]],["name/33",[31,35.993]],["parent/33",[20,1.775]],["name/34",[32,35.993]],["parent/34",[20,1.775]],["name/35",[33,35.993]],["parent/35",[20,1.775]],["name/36",[34,35.993]],["parent/36",[20,1.775]],["name/37",[35,44.466]],["parent/37",[]],["name/38",[36,19.898]],["parent/38",[]],["name/39",[21,39.357]],["parent/39",[36,1.775]],["name/40",[37,44.466]],["parent/40",[36,1.775]],["name/41",[7,28.371]],["parent/41",[36,1.775]],["name/42",[23,35.993]],["parent/42",[36,1.775]],["name/43",[8,23.263]],["parent/43",[36,1.775]],["name/44",[24,35.993]],["parent/44",[36,1.775]],["name/45",[25,35.993]],["parent/45",[36,1.775]],["name/46",[26,35.993]],["parent/46",[36,1.775]],["name/47",[27,35.993]],["parent/47",[36,1.775]],["name/48",[28,35.993]],["parent/48",[36,1.775]],["name/49",[29,35.993]],["parent/49",[36,1.775]],["name/50",[30,35.993]],["parent/50",[36,1.775]],["name/51",[31,35.993]],["parent/51",[36,1.775]],["name/52",[32,35.993]],["parent/52",[36,1.775]],["name/53",[33,35.993]],["parent/53",[36,1.775]],["name/54",[34,35.993]],["parent/54",[36,1.775]],["name/55",[38,44.466]],["parent/55",[]],["name/56",[39,44.466]],["parent/56",[]],["name/57",[40,44.466]],["parent/57",[]],["name/58",[41,44.466]],["parent/58",[]],["name/59",[42,44.466]],["parent/59",[]],["name/60",[43,44.466]],["parent/60",[]],["name/61",[44,21.112]],["parent/61",[]],["name/62",[7,28.371]],["parent/62",[44,1.883]],["name/63",[23,35.993]],["parent/63",[44,1.883]],["name/64",[8,23.263]],["parent/64",[44,1.883]],["name/65",[24,35.993]],["parent/65",[44,1.883]],["name/66",[25,35.993]],["parent/66",[44,1.883]],["name/67",[26,35.993]],["parent/67",[44,1.883]],["name/68",[27,35.993]],["parent/68",[44,1.883]],["name/69",[28,35.993]],["parent/69",[44,1.883]],["name/70",[29,35.993]],["parent/70",[44,1.883]],["name/71",[30,35.993]],["parent/71",[44,1.883]],["name/72",[31,35.993]],["parent/72",[44,1.883]],["name/73",[32,35.993]],["parent/73",[44,1.883]],["name/74",[33,35.993]],["parent/74",[44,1.883]],["name/75",[34,35.993]],["parent/75",[44,1.883]],["name/76",[45,44.466]],["parent/76",[]],["name/77",[46,29.802]],["parent/77",[]],["name/78",[7,28.371]],["parent/78",[46,2.658]],["name/79",[9,26.007]],["parent/79",[46,2.658]],["name/80",[4,39.357]],["parent/80",[46,2.658]],["name/81",[3,39.357]],["parent/81",[46,2.658]],["name/82",[47,44.466]],["parent/82",[46,2.658]],["name/83",[9,26.007]],["parent/83",[]],["name/84",[48,44.466]],["parent/84",[9,2.32]],["name/85",[7,28.371]],["parent/85",[9,2.32]],["name/86",[49,44.466]],["parent/86",[9,2.32]],["name/87",[50,44.466]],["parent/87",[9,2.32]],["name/88",[51,44.466]],["parent/88",[9,2.32]],["name/89",[52,44.466]],["parent/89",[9,2.32]],["name/90",[53,31.473]],["parent/90",[]],["name/91",[54,44.466]],["parent/91",[53,2.807]],["name/92",[7,28.371]],["parent/92",[53,2.807]],["name/93",[55,44.466]],["parent/93",[53,2.807]],["name/94",[56,44.466]],["parent/94",[53,2.807]],["name/95",[8,23.263]],["parent/95",[]],["name/96",[57,44.466]],["parent/96",[8,2.075]],["name/97",[17,39.357]],["parent/97",[8,2.075]],["name/98",[58,44.466]],["parent/98",[8,2.075]],["name/99",[59,33.48]],["parent/99",[8,2.075]],["name/100",[60,27.12]],["parent/100",[8,2.075]],["name/101",[61,28.371]],["parent/101",[8,2.075]],["name/102",[62,33.48]],["parent/102",[8,2.075]],["name/103",[60,27.12]],["parent/103",[]],["name/104",[63,44.466]],["parent/104",[60,2.419]],["name/105",[64,44.466]],["parent/105",[60,2.419]],["name/106",[65,44.466]],["parent/106",[60,2.419]],["name/107",[61,28.371]],["parent/107",[]],["name/108",[66,44.466]],["parent/108",[61,2.531]],["name/109",[67,44.466]],["parent/109",[61,2.531]],["name/110",[68,31.473]],["parent/110",[]],["name/111",[59,33.48]],["parent/111",[68,2.807]],["name/112",[60,27.12]],["parent/112",[68,2.807]],["name/113",[61,28.371]],["parent/113",[68,2.807]],["name/114",[62,33.48]],["parent/114",[68,2.807]],["name/115",[69,29.802]],["parent/115",[]],["name/116",[70,44.466]],["parent/116",[69,2.658]],["name/117",[59,33.48]],["parent/117",[69,2.658]],["name/118",[60,27.12]],["parent/118",[69,2.658]],["name/119",[61,28.371]],["parent/119",[69,2.658]],["name/120",[62,33.48]],["parent/120",[69,2.658]],["name/121",[71,29.802]],["parent/121",[]],["name/122",[72,44.466]],["parent/122",[71,2.658]],["name/123",[59,33.48]],["parent/123",[71,2.658]],["name/124",[60,27.12]],["parent/124",[71,2.658]],["name/125",[61,28.371]],["parent/125",[71,2.658]],["name/126",[62,33.48]],["parent/126",[71,2.658]]],"invertedIndex":[["allowscriptaccess",{"_index":23,"name":{"24":{},"42":{},"63":{}},"parent":{}}],["auto",{"_index":65,"name":{"106":{}},"parent":{}}],["autoplay",{"_index":60,"name":{"100":{},"103":{},"112":{},"118":{},"124":{}},"parent":{"104":{},"105":{},"106":{}}}],["baseloadoptions",{"_index":68,"name":{"110":{}},"parent":{"111":{},"112":{},"113":{},"114":{}}}],["config",{"_index":8,"name":{"8":{},"25":{},"43":{},"64":{},"95":{}},"parent":{"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{}}}],["constructor",{"_index":7,"name":{"7":{},"23":{},"41":{},"62":{},"78":{},"85":{},"92":{}},"parent":{}}],["copytoaudiobuffer",{"_index":35,"name":{"37":{}},"parent":{}}],["createplayer",{"_index":47,"name":{"82":{}},"parent":{}}],["data",{"_index":72,"name":{"122":{}},"parent":{}}],["dataloadoptions",{"_index":71,"name":{"121":{}},"parent":{"122":{},"123":{},"124":{},"125":{},"126":{}}}],["displaymessage",{"_index":33,"name":{"35":{},"53":{},"74":{}},"parent":{}}],["enterfullscreen",{"_index":28,"name":{"30":{},"48":{},"69":{}},"parent":{}}],["exitfullscreen",{"_index":29,"name":{"31":{},"49":{},"70":{}},"parent":{}}],["flash7_and_8_mimetype",{"_index":41,"name":{"58":{}},"parent":{}}],["flash_activex_classid",{"_index":43,"name":{"60":{}},"parent":{}}],["flash_mimetype",{"_index":39,"name":{"56":{}},"parent":{}}],["flash_movie_mimetype",{"_index":42,"name":{"59":{}},"parent":{}}],["flash_plugin",{"_index":2,"name":{"2":{}},"parent":{}}],["fromnativeembedelement",{"_index":22,"name":{"22":{}},"parent":{}}],["fromnativeobjectelement",{"_index":37,"name":{"40":{}},"parent":{}}],["fromrequirementstring",{"_index":54,"name":{"91":{}},"parent":{}}],["fromsemver",{"_index":48,"name":{"84":{}},"parent":{}}],["fullscreenenabled",{"_index":26,"name":{"28":{},"46":{},"67":{}},"parent":{}}],["futuresplash_mimetype",{"_index":40,"name":{"57":{}},"parent":{}}],["hasprecedenceover",{"_index":50,"name":{"87":{}},"parent":{}}],["hidden",{"_index":67,"name":{"109":{}},"parent":{}}],["init",{"_index":12,"name":{"12":{}},"parent":{}}],["installplugin",{"_index":1,"name":{"1":{}},"parent":{}}],["iscompatiblewith",{"_index":49,"name":{"86":{}},"parent":{}}],["isequal",{"_index":51,"name":{"88":{}},"parent":{}}],["isfullscreen",{"_index":27,"name":{"29":{},"47":{},"68":{}},"parent":{}}],["isinterdictable",{"_index":21,"name":{"21":{},"39":{}},"parent":{}}],["isstableorcompatibleprerelease",{"_index":52,"name":{"89":{}},"parent":{}}],["isswffilename",{"_index":38,"name":{"55":{}},"parent":{}}],["load",{"_index":24,"name":{"26":{},"44":{},"65":{}},"parent":{}}],["loadruffle",{"_index":0,"name":{"0":{}},"parent":{}}],["local",{"_index":16,"name":{"16":{}},"parent":{}}],["localcompatible",{"_index":15,"name":{"15":{}},"parent":{}}],["lookupelement",{"_index":18,"name":{"18":{}},"parent":{}}],["negotiate",{"_index":6,"name":{"6":{}},"parent":{}}],["newest",{"_index":13,"name":{"13":{}},"parent":{}}],["newestsourcename",{"_index":11,"name":{"11":{}},"parent":{}}],["off",{"_index":64,"name":{"105":{}},"parent":{}}],["on",{"_index":63,"name":{"104":{}},"parent":{}}],["panic",{"_index":32,"name":{"34":{},"52":{},"73":{}},"parent":{}}],["parameters",{"_index":59,"name":{"99":{},"111":{},"117":{},"123":{}},"parent":{}}],["pause",{"_index":30,"name":{"32":{},"50":{},"71":{}},"parent":{}}],["play",{"_index":25,"name":{"27":{},"45":{},"66":{}},"parent":{}}],["pluginpolyfill",{"_index":3,"name":{"3":{},"81":{}},"parent":{}}],["polyfill",{"_index":4,"name":{"4":{},"80":{}},"parent":{}}],["polyfills",{"_index":58,"name":{"98":{}},"parent":{}}],["publicapi",{"_index":5,"name":{"5":{}},"parent":{"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{}}}],["publicpath",{"_index":17,"name":{"17":{},"97":{}},"parent":{}}],["publicpaths",{"_index":57,"name":{"96":{}},"parent":{}}],["registerelement",{"_index":19,"name":{"19":{}},"parent":{}}],["registersource",{"_index":10,"name":{"10":{}},"parent":{}}],["requirements",{"_index":55,"name":{"93":{}},"parent":{}}],["ruffleembed",{"_index":20,"name":{"20":{}},"parent":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{}}}],["ruffleobject",{"_index":36,"name":{"38":{}},"parent":{"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{}}}],["ruffleplayer",{"_index":44,"name":{"61":{}},"parent":{"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{}}}],["ruffleshadowtemplate",{"_index":45,"name":{"76":{}},"parent":{}}],["satisfiedby",{"_index":56,"name":{"94":{}},"parent":{}}],["satisfying",{"_index":14,"name":{"14":{}},"parent":{}}],["sourceapi",{"_index":46,"name":{"77":{}},"parent":{"78":{},"79":{},"80":{},"81":{},"82":{}}}],["traceobserver",{"_index":31,"name":{"33":{},"51":{},"72":{}},"parent":{}}],["unmuteoverlay",{"_index":61,"name":{"101":{},"107":{},"113":{},"119":{},"125":{}},"parent":{"108":{},"109":{}}}],["upgradetohttps",{"_index":62,"name":{"102":{},"114":{},"120":{},"126":{}},"parent":{}}],["url",{"_index":70,"name":{"116":{}},"parent":{}}],["urlloadoptions",{"_index":69,"name":{"115":{}},"parent":{"116":{},"117":{},"118":{},"119":{},"120":{}}}],["version",{"_index":9,"name":{"9":{},"79":{},"83":{}},"parent":{"84":{},"85":{},"86":{},"87":{},"88":{},"89":{}}}],["versionrange",{"_index":53,"name":{"90":{}},"parent":{"91":{},"92":{},"93":{},"94":{}}}],["visible",{"_index":66,"name":{"108":{}},"parent":{}}],["webkitrequestfullscreen",{"_index":34,"name":{"36":{},"54":{},"75":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/master/assets/main.js b/master/assets/main.js deleted file mode 100644 index 64b80ab2d..000000000 --- a/master/assets/main.js +++ /dev/null @@ -1,60 +0,0 @@ -"use strict"; -window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` - ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/master/assets/navigation.js b/master/assets/navigation.js deleted file mode 100644 index 84c5805c2..000000000 --- a/master/assets/navigation.js +++ /dev/null @@ -1 +0,0 @@ -window.navigationData = "eJyNltFu2jAUht/F12gdXdtt3AEtFVIoCEZ3UVWTcQ5gYezIPqagae8+QdLEJrHhLrI/f/rtc5zk7S9B2CPpkIXlIh3KpSItklFckw7ZUc3pQoC5KSe/rHErSItsuExJ59vtv1YpMIB9qzVInDHNM5xPk0q1tJIhV9LcNGC+9OHOkbKgsQp3zkQycvO0R5CGK9lkcqYjkhmgzarlW5Xa4+LTsL/srkXYmotUgySdt1IwsQvBWXcyTPgGKhGXCHpJWenyON98e//gJCrBSsYENaZu8i3t2x/uvpTVDDxLLVLJxOJwaZAKMbXLpYCmHshdHhbpgWHO0ePacXYyRBI20PWs746+r+SSr+r1zMevKujj06A7T3796Y9fBsPnps4qZD4Y6bGuRTUR9FC5QNpt6fmc9g1uMRNABL1Q+4ChnA8r5nJrEcY70OEgHhNJo1YJ7ECEwhTTYcFvLlP1MVIpBBQVEJZMQaage5RtQKYBj8eEVX0lj08jkDYgcoiw5lhD0FMrkW9DO/OYsGoGzDxafer7yoSHrOo+Fzm7E19/fm/fuw04XhglAKGudG5c4T1nY++GCxGvjpeBnE+TSEM4RPjQXgA/lN5wueoyBsZEfE1opBpMKyG4XPVgTXdc6YC1xkWUim0AJ1rtD7FiOFi0DrCkVuBASWx+m34WxOFivme6hYymPYvoFtfbrMeEN9qjBhJF09i7vjCeobGA82lypdQno4dIkV4pPUPjn6T8ytc/Sfn4VZ+kKdD0MEOKtX4uJBUQrsRAULMO/RAUnk8mdk7dyfAVtPHPKL/3hcUhLl39fMWTgC1IjCXzwFi8kdpxGAHSlCKNGT0wZkxgRdkh/7O5cH5naM3ayn/lSIekkGlgFCElteN4bV8+idd2U9e9/wfCkhns" \ No newline at end of file diff --git a/master/assets/search.js b/master/assets/search.js deleted file mode 100644 index b0be3fc76..000000000 --- a/master/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = "eJy1nVuT2zbShv/LzO1sVmhQPPgum8NuqpxD2Un2wpXa4kjQDD9TpMLDjF2p/PevQIgSAL6kmhJ9td4M0d0EXwCNfkDxr7uqfK3v3nz46+5jVmzv3kh6uCvSvbp7c/fYZvn2h2JX3j3ctVV+9+buJa2y9DFX9T9Pf/vqudnndw93mzyta1Xfvbm7+/uhNyZWFJzMvaiqzsrip3b/qKqLJu+Plxf95ZaDh7tDWqmisWP86n//az4f1CXn+v+xXZuLF3H8zXNaFCpn+96crr/NfXfdt2nDuOvu/27Npbc53ZT7fdb8J62fL3s11z6ba2e7Dc9Oa9V801a6yftNlR2a3969PXnftcWmycqi/ie4alLB1nDYjFk/35t/Cdd0Vn/3qVGFfvDAqvXXSYPnvnivmvZwsrQvt6220/3XSQu0Dk82fmkf82zz9S8/vM0+ntWTFY2qdunmZM65DBi3nqOJalQzxS57muPn/tRkwp3bbsx5XbbVRtWzvJ/b3Ow+K17Kj2o7y/25zc3uC/Wq6saZGjkRmGaTk+R0ELQK4vMjaA+qqtV2Zjc4za7qCYqHkj+FcLTo+5+n87UgW+Z1U7WbpqxYTu7dBqw7ZA6xS25njC3uuJp0OXNAcQfTpM+Zo2jGCJp0O3/o2MMmJBEMEgye4/PFs73ag9XE/757YHPv2jzma+/djiIrsob7mLsrF7jnOXd6q8c6bbJ69zkrmGPWuf4mz3m5SfNvyv0hbbLHnPl4u0Ybu9HtMczwfHNvDxeg6d6evfKMJFpmGNmrzmDhO11yQ4LlzxMXnDCninPwI916KPPPuyzP2X6tBrc5ztunrPhltvuu2VJBbCqVNuqXPP1sbXkvhWAaHfpGcwMI7bWwbtI8f9fudtYoPu+GjBHnqnkKs3X8gzGTatM/HzoH47cMLr5B22XxfVbVzdsyncgex1ze61SnqpvctJ7qbnSLaP/1jZtp9Rsw85+5m8Jvv/v+69/e/vq/b37+6fsf/g32hUdz7nXTvXgM7OzvLNWv26bUQj05UkW7Pznp/zrTvDjL4+eCYfl+YsLxrh/xstux3HSX3eBH/5XjKDXXzfV0fixvVdOo6rH8hL2d/nzDgxnrMtc2p8/OwUJP37d5Xm8qpUak4Dnc2Zff4ndMev4NXuXn/Kh+K/Zto35+UdXoMHIuuf6R/Z7VTl52wcf9y+n6ydtzbwB6/k+23Y49PuD4ub/8Kr/WKCif3qoXq37qPsfjX6/v0O+qytqQjxu/V8cLp2XSRwt9/TetxvTouHo1193gyandT3jKzHU3ePpWPbZPHFfb44U3+Pq1Sjcj0nd9NccL5/o6y+6/WbEtX38styP+zn+/XnrGBsv+/Wt/7eQtWVHj6fCQ/tny7ui+7K+9yeOvVVrUx0Yst43T4Cbf32aV2jDdbvtrb/L470PLc/fUXTjf11mg71SxVdW/0s1HVWyxU+eSG2SqHkfva+ji/lU9Mu7ODR/7fTq0/1WPTyNTP3L9dGhfjy1u9j7P80Jev0mLl7Rmu930l1/lN7Z3LY361PyoipHnbF2w/D7AN85Ix+yAoa932dNz802ebT7+XOQjKdnAb6UbbXSj0jS6LYbR9Hp4w5cTbOzNIhhd0eBdWzTZfmSGdy65/jF+/cM7rv37NLuYMrmB491DntbPXinlkuedbnOhknIhAlolkVift+Xv1ab+tq26GsApDo2lT3HYV8zsYLue8vNjXeaqUQNnVmXj6NG/dO5jdZiN2sC6zZSr+2OjyQ4e3M8YTEmLcn4EfatrQ/Af8/QjvrKjYysHU8Vv796Op5bWBTcM0jwfSy19+/fp8drpDrTCxktXV0zbM31uTlff5vVbVYzM7gOXW3PpFf7OD+8n1byW1cesePp6s1F1Pf4U0ZU3Pc6ZbvRTvXS38G5G9pONqop0dhDZud1CkfxUFnN7/L4wbW6J4CyB95uqzPOsePqXek5fsrHiweCyWx7+a/p5JCnEbu7TvsnkPQ9vBXe5ehlbeEfcF8cWS3h/v0+rkU3ciPf62OJq7y6j23xUzS9V+enzxMpkXXXLCvxcWpz5spf74/XTN2rdwIjbQ1nNcnu8/ma3+o+/VZDQjbrW/2yrixMKdm8/2G/VLm3z5vuyaKZyDvuym5KrFEOxMTf3xwaTd+ncw2hWV2W7eZ6PLW52rROn1yprMAEd9e80uzmI/0sPaaFq9e+yec42swLpmz71TRcO5seyKG8IaG+aLxbUj1mxeb4uoH3f9Jpgzmvrv9O9OqTbf7VNU44UC5xLrl9T35dt88z1oA+oNeOnlFG7EdiQ1iNLGXCq0suTO8PnT2U1406L49W3ev2vmnGnk0em+D7fql3za5U9PY1lK8B1rnZNc2qzYAR0TQi0QAxd5WtuN3SVr+X6wY6B3xF2EEv0xHuVj9b/0SDvL7/ZbzOasSK3DSNbZXj99pd0+9uB7XZ7SLfdmwJL+P22fGVP153nrWmwhG895mb5zk2DJXx3Op/lvDq2uMq7nb7+K62VPvU0cd7qaM278pYktqsUmXdczC55pltTaqo7A2lvYLIr/Nsc20qkVbpXjapmR+S0XCIUfe7nYB8D4XbNud0SYTymm49PVdkW22/KvJxKwGE05+abY/MlgsoHR5qY4dgNlwikhQd2mMGYxuWp8SIBHZ6qdKt+Lf/TNIfZIj62bsrnY+slQuoPdGd51nx+p48xzg3LsVAdLSwR2i59KauOCs0NqWu5y6deOpwXij6r83PxW1G3B10WUdsO1BVT9RQYmLZTFu3ZzuZkZ5GR5x+j4g688ik/tlsijPq5fH3/utP5Qj5yZHcqGt28ft1tz82XEfqQfrMV3jXdm6aLrGSV0rc2WTLBC5nVcJFHddCj5L17aJP7nLq2vBOczHD26afvPqlNqy9icFEY1j79pHob27ONZZbbGr5DOb3G1hexBLd3rtDugqKt0zx7mq+SvtUiS0Kb50asX9cHtWne6ac7e3U4nTtOOyPV0cgiAZb6fY1r+qlruWRf/dmmekWeG8e52SKa2aT57CHTN1rsgby/Joqu5ZKhdNsicEZ+zq6Kf2ae2z96Y/TO/gEJbvfohtXUz0nMTLH2NmXn5lPHRousyd0Bod/HX6ObXJe7xpfeqZudJOxUVamtOdp3VbJgDFRnA4sE1r3x+EvazE7MTctDern6zA3l+CLf/IqA1XCJQEp9pqTKf7xCxLppW+ULSrmbKs5nHa6aaQq7+VI99EPxk3r9NX28pouyolCvTdd2kZWJhfzx+tQ1PRybLrNKFcfX7WcLWTe99NMK84LZ8pg5jObYdndsu8jGrVJbVTRZmnfH3d5mk6cn8AbuZKKTdp5dJlGzFg3/QO6sRaM6NV4ioCe7qvxjejhcMf6PNh47G/uTjUUqYFX+zmD/q2pNbZVXx1MDCxaa6tHDXuyE9Wjg8WzgysDs6v9v797yiv/uhbfU/tvJgzrAz317+ZiOdx8LYAcUyDR1aOrtP7L6H1nxrLR8tleHyYIQKL4RBrFYYAwkAbsNEYnFguIDChTbFJ9YLEQOrkDBYVqxWFhceAHH5Ci7WC48LsqA8Y2TjMUCnAU2UJAXuMZigbIwBwpwhHIsFtgV0AOFyWIey43mywgEDmZEQBYLig9EUGxTPGTB4cLBI3icYDqy3IrLgCVwwYWsZLmHykMn8ImOkZPFgpsJUlCQFznKgknCJFbBmYFHVZbrufkj4MtJ/yJygeoaUoTlFquZAAauWxf5y3LhcnAMjBHTmMUCuwxnUFSIzSyntQuQBEptgEeWfXSXwM3oo/uCgfExzugudYTiLNd3DKgDuw4yneUSyguIB2aPg7L4cnkFE/jA3GKU9yyZ9rDxz0j6M0F/lguTA4NgfJgFLRcYAw3BuCAZWiwsHihCgY1xomVnNhY2Gp3ZRqjRor3HgEhj3QcZ0nIrKAspwXV0hCgtuJpyABNeTjFfWiw0Jm5CsY3SpuW2xbPgE9weX2BPCy9nl1HU+HKGSNRi4c0EUyjKi1xqueomG1ONIJFRSrVgus6HVjh1n2JWt4TpvH+dNimPYXlX3gKxtmmTzvR0f2wz/WardzNjT+Z1932Wq7EPbkxFUb/udlk+/ev584KZQ9VgSDdjNWagLK4GI7werHH78DJZw113JVpjhsVnazC6G+EaM0gOXYPhXY3XmIFx+RoM7ibAxg2QS9hwhDchNmaIsxgbDPN2yMYMlUXZYIjXYzZmaFdwNhjoUqCNO7IvkzY8sK9EbdzVl83a8Ap8G2xjDxwObRsZMVfjNu5KzOBteCG+FrhxHy2PuOHnegNyY4Y3k7nBMJeAbuz0YZK6jeQM87Ebt/euGAtfcBBcJG9YZVchI+4SNpO94dVsCfjGDZhD33CUV+M3ZmiX+RuM60oAx9XcBdqFJXcN6ZrzAC8xuPEH+CVD41O48V3t9RiO238MDoe771oQx005L5A4nF9eQx64OQeTxeG84xYYx0+K2DRuLDm6DcdxA+XwOBzh1UCOGxqDyOHIrkVyzMB4TA6GdgOUmzPTsajc+Ex3PZab0YMMLjfahdeCOe7KyiJzeH29Hs2xV1kOmxtZZq+Gc8zgmHQO19RvwHPcjfQsPoc31LcDulmL3GVCN7HIXYnomAHOZHQwziUgHbdCyqZ0uER6G6ZjJ/V8TjeS4N8I6sYDPUfpfXej/6Kl+c+AxZ1t2B8rSref3zd2umt+LO9o5fz3abh3jMXqT+v7dOmL+kn/Lm7hf44MO7l/Tl9UcWow5dBqin3rPmT7zU8X3+zT+mLxRZcTXyue8mgj265IPvK54qON/pKZz9H5dO4vSn8mvPFu8IKv+4NpxbvV053YIbifAfn6lx+Om47z9GG+BHK0YV0wV7X2LCB41u/FpXuyA8bPz1z4Xa72IwzhaMm57pYnWbmfH+Z4uj+1mbxZ91bGUs/i+/fflPt9WkzJCMRQFrt6c2rIm1LnBLYxhxRmxXRqs3w4Zsx8c0VQpuWyoVFIIjgHVw3XDp6OdLu6mVMpmRfYXjXp2HmS8bCsVssE5Yw3NQa2pvppFs2aE878YL5YKGOHNMZDmXU8Y55yslpfOJJBj0eUaVL1eU7SPC+slzJv8e5jPKZTmy8R0LkK+12hP3w+U0zn5urU/Ms8zulq89QTvaLQPEf2tWquja1WzRcOTukwrg2va/ylA/yUXd19uu0XDu+QtpjTTkxqxyZfYhh0H13++bHu6u3zwuqaluemy/dVf2rj/Sv8Fs54aH3D+nX3ZQIzs/qPqq7Tp5lP89h2f2q7fHjcvRjS2uiG7JbgrO3Mj+VLpn68nIU5192yVXvNtpidjDq675tMbmbcGxlx/qycjw2wvJ/a3O5+EliOR3D5tyDnBFG0+++1QVjQGw+iaPe7vtntQdSvuwkaOR5F/bq79CuQc8JgnPEdj4X78/5zAsrqrze6jGiOlMt5AWV12jWuT41vD6gt9BnSStW12r5VxdPcsWu3z/v2V4Vlz1pv1VO6+fyuq3JM19K8K2+ZuXiVEORwtBYCbt+/tWurHzAOUGS4PgRmxQMGMlrzmBXONVUOGM5IneOWYBiVDRgKrG3MC2RWNWOkPyY/DTAvhGsCWND9haoFdD/5DZm5SuBUKmAUuFZxSygXqxMwDlCfuCWIORUJGM90TeK2R8Xaqo48Lcavh8+TLrfyAOMZrz1cHxC/2gBDmqo33BAUt8KAYxqvMdww51yoKuBJZ1BXuEXK3EoCDGW8lnB9n/CqBzCcsfrBDcFwKwY4nvGawbyQBlzxd3GxPvC7uIUmptvtKYv9T1psc0aZ6ejxPt1uT2ns86ktAzH+Lm6EeH0EvITxktNZqK53PSdjBQFcD+T6APg56mX3bOzWO+dmpcj1FXDtfM+cRPCS01kur3V4FQbqnfIyrMtu58OePoLZOdXlYGYhnT6OOVnUZbH92ap6Dn04665ruVwoMylIH8e85OTyI6nb+qDPx/N1Ybe4qQeOhuY6vl0D9ZyBeLr8xo6ex3F677PSrkt3PofW9AHMSLQuup/HZE4RzEqtLgWxSfP8u0+Nqoo0/6H3zM820jxXx9aZ1ZoZ0h8Pd1mxVZ/u3vx11xet39zRV/Kr5O7hbpepfFvfvflw1/8cSbk/Hinblpu2++cfx8t+V5umrPTF5up/ru4ePqwe1vKrJIz++OPhQ9+4+0P3H3ob5//SNRR3Dx8EaigGDYXTkO4ePhBqSIOG5DSUdw8fJGooBw2l0zC4e/gQoIbBoGHgNFzfPXxYo4brQcO10zC8e/gQoobhoGHoNIzuHj5EqGE0aBg5DeO7hw8xahgPGsZOw+Tu4UOCGiaDhokrAK0HAbUjhuIRnno6+YgHmXwlV9JtDATkKkhoXQh6COKv4nXsNh6KSLgqElobQsLGQyEJV0lC60MEsPFQTMJVk9AaEWvYeCgo4SpKaJ0IqCkxFJVwVSW0VgTUlRgKS7jKEvH4oxqKS7jqEsn4oxoKTLgKo9Xoo6KhwshVGInRR0VDhZE3R3UKi2FjME25CqNOYXBM0VBh5CqMtGYIjioaKoxchZHWDMFZmYYKI1dhpDVDeGYeKoxchZHWDMHZmYYKI1dhpDVDcIamocLIVRglo6OKhgojV2FSa4bgFC+HCpOuwqQYFYkcKky6CpPdMgjHsxwqTHorodYMwfEswWLoKkx2CoNrhRwqTLoKk53CoLblUGHSVZjUmpFQ23KoMOkqTGrNSKhtOVSYdBUmx+cwOVSYdBUmtWYkHBhyqDDpKizQmpHyIaCvElcjwVBggSuwQEtGBg/B+qsgCdzGQ4EFrsACLRm5ho2HAgtcgQVdrgXVGQwFFnjplpaMjNAtg4TL1VewHo96qK/A1VfQ6QsqOxjqK3D1FUTjnT3UV+DqK9CKkQm65aG8AldegRZMAEdFMJRX4MprrRUTwFGxHupr7eprrRUTEIh6PZTX2pXXWgsmgBP+eiivtSuvtRZMACf89VBea1de6y6dx2n5UF9rL6PXigmgsNcgqXf1tdaKCeC0ux7qa+3qa60VE0Bxrof6Wrv6WmvJBHDaXQ8FtnYFttaSWUOBrYcCW7sCC7Vk1lBg4VBgoSuwUGtmDWfOcKiw0FVYqDWzhgoLhwoLXYWFWjNrqLBwqLDQVVioNbOGCguHCgtdhYXdphFv/oYKC719o9bMGiosBFtHV2Gh1swaKiwcKix0FRZqzazRDBYOBRa6AguT0akzHAosdAUWacmEUJ3RUGCRK7BIjC4X0VBgkSuwSEsmFOCWo6G+IldfkVZMCJUdDfUVufqKtGJCqOxoqK/I1VekFRNCZUdDfUWuvqKuMAGVHQ31FXm1Ca2YECo7AuUJV1+RlkyISxtDgUWuwCItmRAqOxoKLHIFFncCQ8qOh/qKXX3FWjERFGc81Ffs6ivWkong1BkPBRa7Aou1ZCIosHgosNgVWKwlE0GBxUOBxa7AYi2ZCAosHgosdgUWa8lEUGDxUGCxK7C4q35BgcVDgcVeAUxLJkJZZwxKYK6+Yq2YCJfPhvqKXX0lWjIRLqENBZa4Aku0ZGIosGQosMQVWKIlE6MJLBnqK3H1lWjFxFBfyVBfiauvRCsmhvpKhvpKXH0lWjEx1Fcy1Ffi6ivRionX6JaH8kpceSVaMDGUVzKUV+LKK+kKrHD+Sob6Srwaq1ZMDPWVgDKrX2fVkomhwMzf3ObWfzu216pJRgq1oNi68qqtK62cBNf6V6DeuvIKristngRKzfzNb+/VXFdaPwlUm/mb394ru660hBIoOPM3v71XeV1pGSVwTjN/89t7xdeVVlKCS7crUH5defXXlRZTgqu3K1CBXXkl2FVX4ofqM3/z23v660r3CdYfqvQPSv1dnWyFBQir/Z4ATb1/hRWIKv5+yd/U/FdYgqjq75f9Td1/hTWIKv9+6d/U/ldYhKj675f/Tf1/hVWICICPAAwDWGEZIgrgYwDDAVZYh4gE+CjAsIBVjLJ1gWiAhwOE4QGrBBoAREB4SEB0VX5YjBOACQgPCghDBcQKtkfgyZNhV+qHhTEBwIDwyIDoiv2wyCQAGhAeGxBduV8IgXsPSNDjA6Ir+QsNc5ABIEGPEYiu7C800EEGgAQ9TiDIlHHhTlMAVCA8ViC68j+seAkAC4RHC0QHAISA+00BgIHwiIHoIADcZQuADITHDIQ0Agyxf6BAjxuIDgUIEWEDCH96GuxwgBB4DAN8IDx+IKRRIR7DACEIjyGIDgsIWmEDQIUeRxAdGhCExwFACcJjCcLABMLjAOAE4fEEIQ0UxeMAIAXhMQXRcQJBeBwAriA8sCA6ViAICxmwBeHBBREYBI+VCPiC8ACD6JiBIKxEwBiEBxlEBw4ExWgsAc4gPNAgOnYgCAsRsAbhwQbR8QMhsRABbxAecBAdQxASCxEwB+FBB9GBBCGxEAF4EB55EB1MEBILEcAH4dEHsR6trQiAH4THH0THFASuHArAIIQHIUTHFQQuAArAIYQHIkTHFuAWWgASITwUITq6ICQeBoBGCA9HiI4wwP2sADxCeEBCrI0G8SgCTEJ4UEJ0nAHWQAWgEsLDEmJtFIiXA0AmhIcmxNooEI9CQCeEhydERxxg2UcAPiE8QCFCc0oE700AoxAepBAddxCYwAnAKYQHKkQoJ7JiwCqEBytEGExkxYBXCA9YiI5B4KwYEAvhIQsRhuNZMYAWwqMWogMROCsG2EJ43EKEo+hVAHIhPHQhOhoxlhUDeiE8fCGi1URWDAiG8BCGiMREVgwohvAwhohoIisGKEN4LEN0eAJnxQBmCI9miCiYyIoB0BAe0RAdpMBZMUAawmMaIgonsmKANYTHNUQUTWTFAG0Ij22IKJ7IigHeEB7fEFEykRUDxCE8xiHi1URWDDiH8ECHiMVEVgxYh/Bgh4hpIisGvEN4wEPEciIrBsxDeNBDxMFEVgy4h/DAh4jXE1kxYB/Cgx8iDieyYsA/hAdARBxNZMWAgQgPgog4Hs+KAQcRHggRcTKRFQMWIjwYIpLVRFYMeIjwgIhIxERWDJiI8KCISGgiKwZgRHhkRCRyIisGcER4dER0wANnxQCPCI+PiA55jGXFAJEIj5GIJJzIigEnER4oEYaUwKwQkBLhoRKRxBNZMaAlwsMlwvASmBUDXiI8YEKr1XhWTICYkEdMqCMgMCsmAEzIAya0ovGsmAAxIY+Y0EqOZ8UEkAl5yIQ6BAKzYgLEhDxiQh0BEQE+CwyQCXnIhDoEIvDxMALMhDxmQh0DEfiIGAFoQh40oVU8nlYToCbkURNaJeNpNQFsQh42ITF68pMANSGPmtDxDQmUVhOAJuRBE+oYCEyrCSAT8pAJdQQEptUEgAl5wIQMMMFpNQFgQh4wIQNMcFpNAJiQB0zIABOcVhMAJuQBEzLABKfVBIAJecCEOv4B02oCuIQ8XEIGl+C0mgAuIf/tiY5+wLSa0OsT/vsT5gUKnFYTeoVi8A4FjafVBF+j8DRoXqTAaTWhVyn8dykoGE+rCb1O4b9PYZgJTqsJvVLhv1NhmAlOqwm9VuG/V2GYCU6rCb1a4b9bYZgJTqsJvV7hv19hXrDAaTWhVyw8akKGmuC0mgA1IY+akHnRAqfVBLgJedyEDDfBaTUBbkIeNyHDTWBaTQCbkIdNyGATnFYTwCbkYRMy2ASn1QSwCXnYhAw2wWk1AWxCHjYhg01wWk0Am5CHTchgE5xWE8Am5GET6igITKsJQBPyoAkZaILTagLQhDxoQgaa4LSaADQhD5pQMHpeiwAyIQ+ZkEEmOK0mgEzIQybUIRCYVhMgJuQREzLEZCStBsSEPGJCHQDBaTXgJeTxEjryErwcAF5CHi+hIy/BoxDwEvJ4CXX4A6fVgJaQR0uowx8Cv7pAgJeQx0vI8JIgRAEAXEIeLiGDS/AbDARwCXm4hDr+IfBbDASACXnAhAwwwW8yEAAm5AETWpuXaPELkgCZkIdMyCCTtYAvDAJkQh4yoY6BCPxWAwFoQh40IQNN8JsNBKAJedCEDDTBbzcQgCbkQRPqKIjAbzgQwCbkYRMy2GQdwk4E2IQ8bEIGm8AX8ghQE/KoCRlqssZzEaAm5FETMtQEDyUATciDJhQaHeLJCGAT8rAJGWyyxpMR4CbkcRPqQIgIcUoAyAl55IQ6FCJCPBIAOyGPnZBhJyF8u5sAOyGPnZBhJyFOCQA7IY+dkGEnIV7TATshj52QYSchXtMBOyGPnVAHQ0SIRwKgJ+TREzL0JIywAaBEj55Qh0NEiJUI+Al5/IQMP9GJFYoAKNHjJ2T4SYSVCPgJefyEDD+JcHIK+Al5/IQMP4lwcgr4CXn8hAw/GVkVAD8hj5+Q4Sf4nQsC/IQ8fkKGn+D3LgjwE/L4CRl+gt+9IMBPyOMnFI+fqCGAT8jDJ2TwCX5/gwA+IQ+fkMEnEU5PAD4hD5+QwSe4ZgboCXn0hAw9wS+CEMAn5OETMvgEvwxCAJ+Qh0/I4BP8QggBfEIePqFkamUG+IQ8fELJxMoM6Al59ISSqZUZ0BPy6AklEyszwCfk4RNKplZmgE/IwyeUTK3MAJ+Qh08omVqZAUAhD6BQMrUyA4BCHkChZGplBgiFPIQiVxMrswQIRXoIRa4mVmYJIIr0IIpcTazMEkAU6UEUuZpYmSWAKNKDKHI1sTJLgFGkh1HkamJllgCjSA+jyNXEyiwBRpEeRpGriZVZAowiPYwiVxMrswQYRXoYRa4mVmYJMIr0MIo0PzMV4x/+ACBFeiBFGpCCX3WTgKRIj6RIMT4jSoBSpIdSpJiYESWAKdKDKVKMz4gSsBTpsRQpJmZECViK9FiKFBMzogQsRXosRYqJGVECliI9liLNyycj8xGgKdKjKdLQlJH5CNAU6dEUaV4+GZmPAE+RHk+RhqfgtyYl4CnS4ynS8JSR6QTwFOnxFGl4Cn71UgKeIj2eIg1PifHvJQGeIj2eIg1Pwe9gSsBTpMdTpOEpIxMa4CnS4ynS8JSRCQ3wFOnxFGl4ysiEBniK9HiKNDwFv0oqAU/p/1v3I5AvqmrU9gfzY5AfPujPFf9197/jj0PqmlLnRP9OpK4avfnr77/PPwf55q+/rV+E1H/TfuBPcVs2Yzrb1FMjy2bm2AgtE5HkWchz20IUnC3Ea66F8tWxsbJsMO9D27B/NdfqF4rO5vTLCZ0FfR6r+4cmSGwPhWpey+pj93kOy4O0blqffDcekvXRQ7DiezDfcUo3G1XXjo9VbPkQydFHeLwdfSiC5+M1/ewYjiy7ccIzcsheTl/4tkVNtqgjnq22KW0jMjzbCJgKbJvSfLzFMmONL9P9D3f6LcFjr/VPRvCezOCrX9ZNC0us+j3Co4ew93D0STGvPx5T/T0I235i2ZfHwPWpUmOWArZZ/SO/5aEZPLaVPT4ET0ePbZZvt93v0p8tWaOAGZW2khU7RwFWf/KezshP9tozo3WHepLmWS1eUqej1tZICXlPU/81a57T+tkxdLbDmyH159TSJnvM8qz5XLW5ch+gIFuCYS+RVS9BrhPzmQPbsC2Mft40/yuP/6vr/eYfyfEfOqtm+6v2zlxkOYzZVuqmavVvJTuh25rmPquiUZ+avSpa52FZ4y883rR+3fPYyf1MQkytVipt1MF8rsPyQpa2JG/wbCq1VUWTpXm3cORZ3biLkt0F634+WvWqCJiqaCv9W9dmWdI/oW0/LitZYBkzX5OwYgzsNGgVso2MTWWBvQKteHe4VY+tI/vAWoLWXBu7tM2b/w3HkLSTMt7MczS2K4vGubvYmjeSfpSv+xUh6VeEgCefrSqcFTOyAo15C+82q9TGEZ2dAYS8zM3/8Xd7DNtPs1/xdNnB/IN4S5Xz+/a2dWFb76e1Vf8PYkr6kG61B3dFtfNB5vSrDeVq547h1do2xBwfh3Rbmc/X2pZC2xL/3tqDa0baZphKa6u06b7eam00rPku4g0LlboTXGJ3MnOsDz5GZt1aGNl6CHo98O5RVZW7ANkz25q3lPkf/rBji+3Y1n1s/T+I52CXvpTVLveyEX3y1kofon5l6xNXpuw6u+khc3cEVjJHzLm0MzRcIUMryoj3ULoZtGyrjZcv2XsM/Z7vcQLtMxrmtmNXVhuV5tmTt9u0e1P2+7S436cxJ63OeL1Jc3dGJDvyoN9sxP3iLnlTrvVtadu2vcEM+l6J+16R/R3EzM6HSpaWk4AprJOhtD6oTdNNJm7kdv7bJ6Yi7hNT5kwOvoZkj8DAHoGiH4H9PwRvDntK9+qQbh/bpnHnw8S+hRVPgI6xfXo4DMoS9hNd9w9y1fdLwOuXp4ObD1v6DnnzznP6ooqyefbjC+wZlzlJ9l9mtxdya5EkZurynG23rjIDKx1Y85L559JdkewCXMKLw9/8BvbekDfQsiJzoiB7zuWaqJs0z7tVGqTV0rIoeYP2aLHqPoDoRGdtpyRvQej29EXqbj2sfoq5Ib2UH71R7czV/fjgWfO/u24L0l6tY96En9W6hFHUXp5kF+eYdsZSCHuURP1evZ8MJPu2T58ntm3biXrYb0QS3pz4f+khLVStnvQMsXFu3i59rXgButb2ZeEMr8Qu1q14q2VvcZ8Vm2fXml0fWfHmL53iN1X29ORmN4m9WWfWci1T5Niyp/0V7yHk3fdKzXD1k7jYnlAS3mPIVdOo6rH85Mwj1k2eEgzqC/JhX5Bn1o/MRxttFdpxnqwlUb9E85Y7881Pd51K7HWKN6W6nw61U2J70TuV7xPZR8lbN7T5wXJqTztrrp2NO7GSnecwdaht9CVKb7a36zvc/n/K1YtygrLLOie8Qn1uHfWdyKxd79NP6pPatHr6RntT/R6btSz0Qu1LBES8rvULicJemIXsCzhxX5Aj3mp4/iqrLSr70Z/oRg+gJLMEsS9fMgXtR/ZzZCK5Ii1KJ42wN9gR71GdeZshYvty6+jLjou5LynUizv1RtboZs5uhXpVbupHdjGJ19vGSNfIGcX2LqwX9gyDZsM7MGtPYTz9FmXh9rW192TCrKKsGqfWkNj1LGa9t2j33YbV3cPb0RATNJePdZmrRsGClBVZxAus3DkFRWlZ6LfmwXEERrwn6IZkU+XgOOsFx9Us5C3rHWKpG3+plJZaJe9RlsXp7IE789jPIexrRgnzfg/pn60jMrtgtGbe40EVWVGo1yZ9dJN7W2zrvljSV84p4MaoirbK/ZkntAZUP4WLdf+PpB+5zJL/IdUKb1TlkVk7AabeeNgbZ+Z2h7T1mLIdPEXHDpHM8XhQen5pQJ60dibBvp9j3pzqE3x9qNZSVr/4JryFY1g/FPbWmpg7fGNG5ar7r8692nkSU6nGWtUWTebOzvat9lszse4z2L7IRMyCmXHz4h44iu0hzzz2cDR0/IytM7TsVCboU5mkT2WYG/tD3j5lxaHMP+8y9xSRfWRH8pYraMaanJjHfHozXsXYLhQEfeLZJ+0kmaIsK7deZFlNeNnLoVI7VVVqW+kPdFeexO15XfRLhUh6/TBrN4eqOyri2RZ26Vn2Iu0nD2LmKIeq/PTZw8ixNZQSpnLaxzzb+BtVO0LmrfZ28uyjO0U6hYIZtg6pm/EIGwDrn3U9PpO+CMtcfv9sU332w91POKlivzrE/erAPOdSqXT7uW58GmBDcOr3XHRaevoFTjIZoJGUO4Pai9DpvFS/PEvmEzTjQB/QUm5mYk/QIW8KqdSfrarHGJw9WiVT7v2n5W0zzpzEk3uHczd5tvlYFrkjArvmEfF02hlDJSg72WBq3rZF7vixBxDzMOqwWqzffLZEwguqBlDOnhhlPzHGvayJp7U6devi9qNMeOO4Tpus3vkFVHLqpzxDQzZop7vB6bhWXwyQzM7bVGWeZ8XTo3pOXzIXakfWstyDQRH2q/6qnxwC3sxTq41bH7C6M2J2p9rUcDdnDf6IN8ZqlXuHWfR3TCwN8/KHWlWZsy20zx4yk9daNVPHrqxuYmpFjZ4rsGf5vo4mmfyxVo17OsQupPAsPJev9euuP6Hj5hu2nGW/ukWnkgjTwz71ci5rXmLuUuty81E1XebiWLLUkZyS9r6a3ZedKWDqpivbeBmNPaS54xecd3COh/bxca15BRw7EWaejdHIqH4G6nMOafbnC0TU9xzzVEvdeI9Yfz7IGrdMMbcHVdVqsKW1Swh9isI0WB+8lETYJ/gkk80e7Xhx2TmzZBb06tfdLsuHpcHA3squmBPv6w7tC+0Fgphctqm849r2sYD1DBvlY93tVt2IbCjUS0uu+n8wV9umSov6kFZeFcAueDCTk+bzQb1WWeOGGVv1eyY2bQuNXCpV12qbq+LJ23bYVW1ivtfRFvu2UeWLqvy3KSxjpy0M9WDkVJthDrX28FSlW9WUz01z8E6y2ysu9UdbT0SZudnw1kthH+0QzDMrbZWPHjK2U1vmKde2yqvjcx8c37d7V6z7e131xYWAlzSg4WhTodPp/DnWNs9pUbgszt4FzTHlTzt2yjvLTrt/9Ma41X08S1ntg0r7mTLT15cy9/d2oYM7V/1k0/+DySdf08o9mWTNz0ysq02URVvU7UEXnToQ3XiTl3BQE/XDuq8/EpOXv6rHJ0cgNuAOedOrtuGdMrNWypA36n0kl9jlIOay9vp0aIc3ZCfcvM3Ea7b152OHq/MU/5oVW/fNSPskAvOtUWPExxf2WQHmm3oDG8I+yyV61CXifgbjvMfyx8PdITuoPCvU3ZsPf/z99/8Dns597g=="; \ No newline at end of file diff --git a/master/assets/style.css b/master/assets/style.css deleted file mode 100644 index 5ba5a2a90..000000000 --- a/master/assets/style.css +++ /dev/null @@ -1,1633 +0,0 @@ -@layer typedoc { - :root { - --dim-toolbar-contents-height: 2.5rem; - --dim-toolbar-border-bottom-width: 1px; - --dim-header-height: calc( - var(--dim-toolbar-border-bottom-width) + - var(--dim-toolbar-contents-height) - ); - - /* 0rem For mobile; unit is required for calculation in `calc` */ - --dim-container-main-margin-y: 0rem; - - --dim-footer-height: 3.5rem; - - --modal-animation-duration: 0.2s; - } - - :root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ - --light-color-background-active: #d6d8da; - --light-color-background-warning: #e6e600; - --light-color-warning-text: #222; - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-background-active); - --light-color-text: #222; - --light-color-contrast-text: #000; - --light-color-text-aside: #5e5e5e; - - --light-color-icon-background: var(--light-color-background); - --light-color-icon-text: var(--light-color-text); - - --light-color-comment-tag-text: var(--light-color-text); - --light-color-comment-tag: var(--light-color-background); - - --light-color-link: #1f70c2; - --light-color-focus-outline: #3584e4; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: #9f5f30; - --light-color-ts-method: #be3989; - --light-color-ts-reference: #ff4d82; - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var( - --light-color-ts-constructor - ); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: #c73c3c; - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - --light-color-document: #000000; - - --light-color-alert-note: #0969d9; - --light-color-alert-tip: #1a7f37; - --light-color-alert-important: #8250df; - --light-color-alert-warning: #9a6700; - --light-color-alert-caution: #cf222e; - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - } - - :root { - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ - --dark-color-background-active: #5d5d6a; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: var(--dark-color-background-active); - --dark-color-text: #f5f5f5; - --dark-color-contrast-text: #ffffff; - --dark-color-text-aside: #dddddd; - - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-icon-text: var(--dark-color-text); - - --dark-color-comment-tag-text: var(--dark-color-text); - --dark-color-comment-tag: var(--dark-color-background); - - --dark-color-link: #00aff4; - --dark-color-focus-outline: #4c97f2; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: #ff984d; - --dark-color-ts-method: #ff4db8; - --dark-color-ts-reference: #ff4d82; - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: #ff6060; - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - --dark-color-document: #ffffff; - - --dark-color-alert-note: #0969d9; - --dark-color-alert-tip: #1a7f37; - --dark-color-alert-important: #8250df; - --dark-color-alert-warning: #9a6700; - --dark-color-alert-caution: #cf222e; - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; - } - - @media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var( - --light-color-background-secondary - ); - --color-background-active: var(--light-color-background-active); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-contrast-text: var(--light-color-contrast-text); - --color-text-aside: var(--light-color-text-aside); - - --color-icon-background: var(--light-color-icon-background); - --color-icon-text: var(--light-color-icon-text); - - --color-comment-tag-text: var(--light-color-text); - --color-comment-tag: var(--light-color-background); - - --color-link: var(--light-color-link); - --color-focus-outline: var(--light-color-focus-outline); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-project: var(--light-color-ts-project); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-reference: var(--light-color-ts-reference); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --color-alert-note: var(--light-color-alert-note); - --color-alert-tip: var(--light-color-alert-tip); - --color-alert-important: var(--light-color-alert-important); - --color-alert-warning: var(--light-color-alert-warning); - --color-alert-caution: var(--light-color-alert-caution); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } - } - - @media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var( - --dark-color-background-secondary - ); - --color-background-active: var(--dark-color-background-active); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-contrast-text: var(--dark-color-contrast-text); - --color-text-aside: var(--dark-color-text-aside); - - --color-icon-background: var(--dark-color-icon-background); - --color-icon-text: var(--dark-color-icon-text); - - --color-comment-tag-text: var(--dark-color-text); - --color-comment-tag: var(--dark-color-background); - - --color-link: var(--dark-color-link); - --color-focus-outline: var(--dark-color-focus-outline); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-project: var(--dark-color-ts-project); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-reference: var(--dark-color-ts-reference); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --color-alert-note: var(--dark-color-alert-note); - --color-alert-tip: var(--dark-color-alert-tip); - --color-alert-important: var(--dark-color-alert-important); - --color-alert-warning: var(--dark-color-alert-warning); - --color-alert-caution: var(--dark-color-alert-caution); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } - } - - :root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-active: var(--light-color-background-active); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-contrast-text: var(--light-color-contrast-text); - --color-text-aside: var(--light-color-text-aside); - --color-icon-text: var(--light-color-icon-text); - - --color-comment-tag-text: var(--light-color-text); - --color-comment-tag: var(--light-color-background); - - --color-link: var(--light-color-link); - --color-focus-outline: var(--light-color-focus-outline); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-project: var(--light-color-ts-project); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-reference: var(--light-color-ts-reference); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --color-note: var(--light-color-note); - --color-tip: var(--light-color-tip); - --color-important: var(--light-color-important); - --color-warning: var(--light-color-warning); - --color-caution: var(--light-color-caution); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } - - :root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-active: var(--dark-color-background-active); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-contrast-text: var(--dark-color-contrast-text); - --color-text-aside: var(--dark-color-text-aside); - --color-icon-text: var(--dark-color-icon-text); - - --color-comment-tag-text: var(--dark-color-text); - --color-comment-tag: var(--dark-color-background); - - --color-link: var(--dark-color-link); - --color-focus-outline: var(--dark-color-focus-outline); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-project: var(--dark-color-ts-project); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-reference: var(--dark-color-ts-reference); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --color-note: var(--dark-color-note); - --color-tip: var(--dark-color-tip); - --color-important: var(--dark-color-important); - --color-warning: var(--dark-color-warning); - --color-caution: var(--dark-color-caution); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } - - html { - color-scheme: var(--color-scheme); - @media (prefers-reduced-motion: no-preference) { - scroll-behavior: smooth; - } - } - - *:focus-visible, - .tsd-accordion-summary:focus-visible svg { - outline: 2px solid var(--color-focus-outline); - } - - .always-visible, - .always-visible .tsd-signatures { - display: inherit !important; - } - - h1, - h2, - h3, - h4, - h5, - h6 { - line-height: 1.2; - } - - h1 { - font-size: 1.875rem; - margin: 0.67rem 0; - } - - h2 { - font-size: 1.5rem; - margin: 0.83rem 0; - } - - h3 { - font-size: 1.25rem; - margin: 1rem 0; - } - - h4 { - font-size: 1.05rem; - margin: 1.33rem 0; - } - - h5 { - font-size: 1rem; - margin: 1.5rem 0; - } - - h6 { - font-size: 0.875rem; - margin: 2.33rem 0; - } - - dl, - menu, - ol, - ul { - margin: 1em 0; - } - - dd { - margin: 0 0 0 34px; - } - - .container { - max-width: 1700px; - padding: 0 2rem; - } - - /* Footer */ - footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: var(--dim-footer-height); - } - footer > p { - margin: 0 1em; - } - - .container-main { - margin: var(--dim-container-main-margin-y) auto; - /* toolbar, footer, margin */ - min-height: calc( - 100svh - var(--dim-header-height) - var(--dim-footer-height) - - 2 * var(--dim-container-main-margin-y) - ); - } - - @keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } - } - @keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } - } - @keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } - } - @keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } - } - body { - background: var(--color-background); - font-family: - -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; - font-size: 16px; - color: var(--color-text); - margin: 0; - } - - a { - color: var(--color-link); - text-decoration: none; - } - a:hover { - text-decoration: underline; - } - a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; - } - a.tsd-anchor-link { - color: var(--color-text); - } - :target { - scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); - } - - code, - pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; - } - - pre { - position: relative; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); - margin-bottom: 8px; - } - pre code { - padding: 0; - font-size: 100%; - } - pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; - } - pre:hover > button, - pre > button.visible, - pre > button:focus-visible { - opacity: 1; - } - - blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; - } - - img { - max-width: 100%; - } - - * { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); - } - - *::-webkit-scrollbar { - width: 0.75rem; - } - - *::-webkit-scrollbar-track { - background: var(--color-icon-background); - } - - *::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); - } - - dialog { - border: none; - outline: none; - padding: 0; - background-color: var(--color-background); - } - dialog::backdrop { - display: none; - } - #tsd-overlay { - background-color: rgba(0, 0, 0, 0.5); - position: fixed; - z-index: 9999; - top: 0; - left: 0; - right: 0; - bottom: 0; - animation: fade-in var(--modal-animation-duration) forwards; - } - #tsd-overlay.closing { - animation-name: fade-out; - } - - .tsd-typography { - line-height: 1.333em; - } - .tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; - } - .tsd-typography .tsd-index-panel h3, - .tsd-index-panel .tsd-typography h3, - .tsd-typography h4, - .tsd-typography h5, - .tsd-typography h6 { - font-size: 1em; - } - .tsd-typography h5, - .tsd-typography h6 { - font-weight: normal; - } - .tsd-typography p, - .tsd-typography ul, - .tsd-typography ol { - margin: 1em 0; - } - .tsd-typography table { - border-collapse: collapse; - border: none; - } - .tsd-typography td, - .tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); - } - .tsd-typography thead, - .tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); - } - - .tsd-alert { - padding: 8px 16px; - margin-bottom: 16px; - border-left: 0.25em solid var(--alert-color); - } - .tsd-alert blockquote > :last-child, - .tsd-alert > :last-child { - margin-bottom: 0; - } - .tsd-alert-title { - color: var(--alert-color); - display: inline-flex; - align-items: center; - } - .tsd-alert-title span { - margin-left: 4px; - } - - .tsd-alert-note { - --alert-color: var(--color-alert-note); - } - .tsd-alert-tip { - --alert-color: var(--color-alert-tip); - } - .tsd-alert-important { - --alert-color: var(--color-alert-important); - } - .tsd-alert-warning { - --alert-color: var(--color-alert-warning); - } - .tsd-alert-caution { - --alert-color: var(--color-alert-caution); - } - - .tsd-breadcrumb { - margin: 0; - margin-top: 1rem; - padding: 0; - color: var(--color-text-aside); - } - .tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; - } - .tsd-breadcrumb a:hover { - text-decoration: underline; - } - .tsd-breadcrumb li { - display: inline; - } - .tsd-breadcrumb li:after { - content: " / "; - } - - .tsd-comment-tags { - display: flex; - flex-direction: column; - } - dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; - } - dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; - } - dl.tsd-comment-tag-group dd { - margin: 0; - } - code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; - } - h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; - } - - dl.tsd-comment-tag-group dd:before, - dl.tsd-comment-tag-group dd:after { - content: " "; - } - dl.tsd-comment-tag-group dd pre, - dl.tsd-comment-tag-group dd:after { - clear: both; - } - dl.tsd-comment-tag-group p { - margin: 0; - } - - .tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; - } - .tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; - } - - .tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; - } - .tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; - } - .tsd-filter-input { - display: flex; - width: -moz-fit-content; - width: fit-content; - align-items: center; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - cursor: pointer; - } - .tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; - } - .tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; - } - .tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; - } - .tsd-filter-input input[type="checkbox"]:focus-visible + svg { - outline: 2px solid var(--color-focus-outline); - } - .tsd-checkbox-background { - fill: var(--color-accent); - } - input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); - } - .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; - } - .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); - } - - .settings-label { - font-weight: bold; - text-transform: uppercase; - display: inline-block; - } - - .tsd-filter-visibility .settings-label { - margin: 0.75rem 0 0.5rem 0; - } - - .tsd-theme-toggle .settings-label { - margin: 0.75rem 0.75rem 0 0; - } - - .tsd-hierarchy h4 label:hover span { - text-decoration: underline; - } - - .tsd-hierarchy { - list-style: square; - margin: 0; - } - .tsd-hierarchy-target { - font-weight: bold; - } - .tsd-hierarchy-toggle { - color: var(--color-link); - cursor: pointer; - } - - .tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); - } - .tsd-full-hierarchy, - .tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; - } - .tsd-full-hierarchy ul { - padding-left: 1.5rem; - } - .tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); - } - .tsd-full-hierarchy svg[data-dropdown] { - cursor: pointer; - } - .tsd-full-hierarchy svg[data-dropdown="false"] { - transform: rotate(-90deg); - } - .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { - display: none; - } - - .tsd-panel-group.tsd-index-group { - margin-bottom: 0; - } - .tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; - } - @media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } - } - @media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } - } - .tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; - } - - .tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; - } - - .tsd-anchor { - position: relative; - top: -100px; - } - - .tsd-member { - position: relative; - } - .tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; - } - - .tsd-navigation.settings { - margin: 0; - margin-bottom: 1rem; - } - .tsd-navigation > a, - .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; - } - .tsd-navigation a, - .tsd-navigation summary > span, - .tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; - } - .tsd-navigation a.current, - .tsd-page-navigation a.current { - background: var(--color-active-menu-item); - color: var(--color-contrast-text); - } - .tsd-navigation a:hover, - .tsd-page-navigation a:hover { - text-decoration: underline; - } - .tsd-navigation ul, - .tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; - } - .tsd-navigation li, - .tsd-page-navigation li { - padding: 0; - max-width: 100%; - } - .tsd-navigation .tsd-nav-link { - display: none; - } - .tsd-nested-navigation { - margin-left: 3rem; - } - .tsd-nested-navigation > li > details { - margin-left: -1.5rem; - } - .tsd-small-nested-navigation { - margin-left: 1.5rem; - } - .tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; - } - - .tsd-page-navigation-section > summary { - padding: 0.25rem; - } - .tsd-page-navigation-section > summary > svg { - margin-right: 0.25rem; - } - .tsd-page-navigation-section > div { - margin-left: 30px; - } - .tsd-page-navigation ul { - padding-left: 1.75rem; - } - - #tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; - } - #tsd-sidebar-links a:last-of-type { - margin-bottom: 0; - } - - a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); - } - .tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ - display: flex; - align-items: center; - gap: 0.25rem; - box-sizing: border-box; - } - .tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ - } - .tsd-accordion-summary, - .tsd-accordion-summary a { - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - user-select: none; - - cursor: pointer; - } - .tsd-accordion-summary a { - width: calc(100% - 1.5rem); - } - .tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; - } - /* - * We need to be careful to target the arrow indicating whether the accordion - * is open, but not any other SVGs included in the details element. - */ - .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child { - transform: rotate(-90deg); - } - .tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; - } - .tsd-index-summary { - margin-top: 1.5rem; - margin-bottom: 0.75rem; - display: flex; - align-content: center; - } - - .tsd-no-select { - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - } - .tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; - } - .tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; - } - - .tsd-panel { - margin-bottom: 2.5rem; - } - .tsd-panel.tsd-member { - margin-bottom: 4rem; - } - .tsd-panel:empty { - display: none; - } - .tsd-panel > h1, - .tsd-panel > h2, - .tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; - } - .tsd-panel > h1.tsd-before-signature, - .tsd-panel > h2.tsd-before-signature, - .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; - } - - .tsd-panel-group { - margin: 2rem 0; - } - .tsd-panel-group.tsd-index-group { - margin: 2rem 0; - } - .tsd-panel-group.tsd-index-group details { - margin: 2rem 0; - } - .tsd-panel-group > .tsd-accordion-summary { - margin-bottom: 1rem; - } - - #tsd-search[open] { - animation: fade-in var(--modal-animation-duration) ease-out forwards; - } - #tsd-search[open].closing { - animation-name: fade-out; - } - - /* Avoid setting `display` on closed dialog */ - #tsd-search[open] { - display: flex; - flex-direction: column; - padding: 1rem; - width: 32rem; - max-width: 90vw; - max-height: calc(100vh - env(keyboard-inset-height, 0px) - 25vh); - /* Anchor dialog to top */ - margin-top: 10vh; - border-radius: 6px; - will-change: max-height; - } - #tsd-search-input { - box-sizing: border-box; - width: 100%; - padding: 0 0.625rem; /* 10px */ - outline: 0; - border: 2px solid var(--color-accent); - background-color: transparent; - color: var(--color-text); - border-radius: 4px; - height: 2.5rem; - flex: 0 0 auto; - font-size: 0.875rem; - transition: border-color 0.2s, background-color 0.2s; - } - #tsd-search-input:focus-visible { - background-color: var(--color-background-active); - border-color: transparent; - color: var(--color-contrast-text); - } - #tsd-search-input::placeholder { - color: inherit; - opacity: 0.8; - } - #tsd-search-results { - margin: 0; - padding: 0; - list-style: none; - flex: 1 1 auto; - display: flex; - flex-direction: column; - overflow-y: auto; - } - #tsd-search-results:not(:empty) { - margin-top: 0.5rem; - } - #tsd-search-results > li { - background-color: var(--color-background); - line-height: 1.5; - box-sizing: border-box; - border-radius: 4px; - } - #tsd-search-results > li:nth-child(even) { - background-color: var(--color-background-secondary); - } - #tsd-search-results > li:is(:hover, [aria-selected="true"]) { - background-color: var(--color-background-active); - color: var(--color-contrast-text); - } - /* It's important that this takes full size of parent `li`, to capture a click on `li` */ - #tsd-search-results > li > a { - display: flex; - align-items: center; - padding: 0.5rem 0.25rem; - box-sizing: border-box; - width: 100%; - } - #tsd-search-results > li > a > .text { - flex: 1 1 auto; - min-width: 0; - overflow-wrap: anywhere; - } - #tsd-search-results > li > a .parent { - color: var(--color-text-aside); - } - #tsd-search-results > li > a mark { - color: inherit; - background-color: inherit; - font-weight: bold; - } - #tsd-search-status { - flex: 1; - display: grid; - place-content: center; - text-align: center; - overflow-wrap: anywhere; - } - #tsd-search-status:not(:empty) { - min-height: 6rem; - } - - .tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; - } - - .tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; - } - - .tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; - } - - .tsd-signature-type { - font-style: italic; - font-weight: normal; - } - - .tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; - } - .tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; - } - .tsd-signatures .tsd-index-signature:not(:last-child) { - margin-bottom: 1em; - } - .tsd-signatures .tsd-index-signature .tsd-signature { - border-width: 1px; - } - .tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; - } - - ul.tsd-parameter-list, - ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; - } - ul.tsd-parameter-list > li.tsd-parameter-signature, - ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; - } - ul.tsd-parameter-list h5, - ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; - } - .tsd-sources { - margin-top: 1rem; - font-size: 0.875em; - } - .tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; - } - .tsd-sources ul { - list-style: none; - padding: 0; - } - - .tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: var(--dim-toolbar-border-bottom-width) - var(--color-accent) solid; - transition: transform 0.3s ease-in-out; - } - .tsd-page-toolbar a { - color: var(--color-text); - } - .tsd-toolbar-contents { - display: flex; - align-items: center; - height: var(--dim-toolbar-contents-height); - margin: 0 auto; - } - .tsd-toolbar-contents > .title { - font-weight: bold; - margin-right: auto; - } - #tsd-toolbar-links { - display: flex; - align-items: center; - gap: 1.5rem; - margin-right: 1rem; - } - - .tsd-widget { - box-sizing: border-box; - display: inline-block; - opacity: 0.8; - height: 2.5rem; - width: 2.5rem; - transition: opacity 0.1s, background-color 0.1s; - text-align: center; - cursor: pointer; - border: none; - background-color: transparent; - } - .tsd-widget:hover { - opacity: 0.9; - } - .tsd-widget:active { - opacity: 1; - background-color: var(--color-accent); - } - #tsd-toolbar-menu-trigger { - display: none; - } - - .tsd-member-summary-name { - display: inline-flex; - align-items: center; - padding: 0.25rem; - text-decoration: none; - } - - .tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - color: var(--color-text); - vertical-align: middle; - } - - .tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; - } - - .tsd-member-summary-name:hover > .tsd-anchor-icon svg, - .tsd-anchor-link:hover > .tsd-anchor-icon svg, - .tsd-anchor-icon:focus-visible svg { - visibility: visible; - } - - .deprecated { - text-decoration: line-through !important; - } - - .warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); - } - - .tsd-kind-project { - color: var(--color-ts-project); - } - .tsd-kind-module { - color: var(--color-ts-module); - } - .tsd-kind-namespace { - color: var(--color-ts-namespace); - } - .tsd-kind-enum { - color: var(--color-ts-enum); - } - .tsd-kind-enum-member { - color: var(--color-ts-enum-member); - } - .tsd-kind-variable { - color: var(--color-ts-variable); - } - .tsd-kind-function { - color: var(--color-ts-function); - } - .tsd-kind-class { - color: var(--color-ts-class); - } - .tsd-kind-interface { - color: var(--color-ts-interface); - } - .tsd-kind-constructor { - color: var(--color-ts-constructor); - } - .tsd-kind-property { - color: var(--color-ts-property); - } - .tsd-kind-method { - color: var(--color-ts-method); - } - .tsd-kind-reference { - color: var(--color-ts-reference); - } - .tsd-kind-call-signature { - color: var(--color-ts-call-signature); - } - .tsd-kind-index-signature { - color: var(--color-ts-index-signature); - } - .tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); - } - .tsd-kind-parameter { - color: var(--color-ts-parameter); - } - .tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); - } - .tsd-kind-accessor { - color: var(--color-ts-accessor); - } - .tsd-kind-get-signature { - color: var(--color-ts-get-signature); - } - .tsd-kind-set-signature { - color: var(--color-ts-set-signature); - } - .tsd-kind-type-alias { - color: var(--color-ts-type-alias); - } - - /* if we have a kind icon, don't color the text by kind */ - .tsd-kind-icon ~ span { - color: var(--color-text); - } - - /* mobile */ - @media (max-width: 769px) { - #tsd-toolbar-menu-trigger { - display: inline-block; - /* temporary fix to vertically align, for compatibility */ - line-height: 2.5; - } - #tsd-toolbar-links { - display: none; - } - - .container-main { - display: flex; - } - .col-content { - float: none; - max-width: 100%; - width: 100%; - } - .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - .col-sidebar > *:last-child { - padding-bottom: 20px; - } - .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } - .tsd-navigation .tsd-nav-link { - display: flex; - } - } - - /* one sidebar */ - @media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - --dim-container-main-margin-y: 2rem; - } - - .tsd-breadcrumb { - margin-top: 0; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } - } - @media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc( - 100vh - var(--dim-header-height) - var(--dim-footer-height) - - 2 * var(--dim-container-main-margin-y) - ); - overflow: auto; - position: sticky; - top: calc( - var(--dim-header-height) + var(--dim-container-main-margin-y) - ); - } - .site-menu { - margin-top: 1rem; - } - } - - /* two sidebars */ - @media (min-width: 1200px) { - .container-main { - grid-template-columns: - minmax(0, 1fr) minmax(0, 2.5fr) minmax( - 0, - 20rem - ); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 0rem; - } - - .page-menu, - .site-menu { - max-height: calc( - 100vh - var(--dim-header-height) - var(--dim-footer-height) - - 2 * var(--dim-container-main-margin-y) - ); - overflow: auto; - position: sticky; - top: calc( - var(--dim-header-height) + var(--dim-container-main-margin-y) - ); - } - } -} diff --git a/master/classes/Setup.PublicAPI.html b/master/classes/Setup.PublicAPI.html deleted file mode 100644 index 3fe043467..000000000 --- a/master/classes/Setup.PublicAPI.html +++ /dev/null @@ -1,67 +0,0 @@ -PublicAPI | ruffle-core
ruffle-core
    Preparing search index...

    Class PublicAPI

    Represents the Ruffle public API.

    -

    The public API exists primarily to allow multiple installations of Ruffle on a -page (e.g. an extension install and a local one) to cooperate. In an ideal -situation, all Ruffle sources on the page install themselves into a single -public API, and then the public API picks the newest version by default.

    -

    This API is versioned, in case we need to upgrade it. However, it must be -backwards- and forwards-compatible with all known sources.

    -

    Implements

    Index

    Constructors

    constructor -

    Properties

    config -sources -invoked -newestName -

    Accessors

    version -

    Methods

    newestSourceName -init -newest -satisfying -localCompatible -local -superseded -

    Constructors

    • Construct the Ruffle public API.

      -

      Do not use this function to negotiate a public API. Instead, use -public_api to register your Ruffle source with an existing public API -if it exists.

      -

      Constructing a Public API will also trigger it to initialize Ruffle once -the page loads, if the API has not already been superseded.

      -

      Parameters

      • Optionalprev: PublicAPILike | null

        What used to be in the public API slot.

        -

        This is used to upgrade from a prior version of the public API, or from -a user-defined configuration object placed in the public API slot.

        -

      Returns PublicAPI

    Properties

    config: object | URLLoadOptions | DataLoadOptions

    The configuration object used when Ruffle is instantiated.

    -
    sources: Record<string, SourceAPI>
    invoked: boolean
    newestName: string | null

    Accessors

    • get version(): string

      The version of the public API.

      -

      This is not the version of Ruffle itself.

      -

      This allows a page with an old version of the Public API to be upgraded -to a new version of the API. The public API is intended to be changed -very infrequently, if at all, but this provides an escape mechanism for -newer Ruffle sources to upgrade older installations.

      -

      Returns string

      The version of this public API.

      -

    Methods

    • Determine the name of the newest registered source in the Public API.

      -

      Returns string | null

      The name of the source, or null if no source -has yet to be registered.

      -

    • Negotiate and start Ruffle.

      -

      This function reads the config parameter to determine which polyfills -should be enabled. If the configuration parameter is missing, then we -use a built-in set of defaults sufficient to fool sites with static -content and weak plugin detection.

      -

      Returns void

    • Look up a specific Ruffle version (or any version satisfying a given set -of requirements) and return it's API.

      -

      Parameters

      • requirementString: string

        A set of semantic version requirement -strings that the player version must satisfy.

        -

      Returns SourceAPI | null

      An instance of the Source API, if one or more -sources satisfied the requirement.

      -

    • Look up the newest Ruffle version compatible with the local source, if -it's installed. Otherwise, use the latest version.

      -

      Returns SourceAPI | null

      An instance of the Source API

      -

    • Look up the newest Ruffle version with the exact same version as the -local source, if it's installed. Otherwise, use the latest version.

      -

      Returns SourceAPI | null

      An instance of the Source API

      -

    • Indicates that this version of the public API has been superseded by a -newer version.

      -

      This should only be called by a newer version of the Public API. -Identical versions of the Public API should not supersede older versions -of that same API.

      -

      Unfortunately, we can't disable polyfills after-the-fact, so this -only lets you disable the init event...

      -

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/master/classes/publicapi.html b/master/classes/publicapi.html new file mode 100644 index 000000000..f8b1a3398 --- /dev/null +++ b/master/classes/publicapi.html @@ -0,0 +1,608 @@ + + + + + + PublicAPI | ruffle-core + + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class PublicAPI

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Represents the Ruffle public API.

    +
    +

    The public API exists primarily to allow multiple installs of Ruffle on a + page (e.g. an extension install and a local one) to cooperate. In an ideal + situation, all Ruffle sources on the page install themselves into a single + public API, and then the public API picks the newest version by default.

    +

    This API is versioned, in case we need to upgrade it. However, it must be + backwards- and forwards-compatible with all known sources.

    +
    +
    +
    +

    Hierarchy

    +
      +
    • + PublicAPI +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Properties

    + +
    +
    +

    Accessors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    +
    constructor:
    + +
    +
    +
    +

    Properties

    +
    + +

    config

    +
    config: Config
    + +
    +
    +

    The configuration object used when Ruffle is instantiated.

    +
    +
    +
    +
    +
    +

    Accessors

    +
    + +

    version

    +
      +
    • get version(): string
      • +
    +
      +
    • + +
      +
      +

      The version of the public API.

      +
      +

      This is not the version of Ruffle itself.

      +

      This allows a page with an old version of the Public API to be upgraded + to a new version of the API. The public API is intended to be changed + very infrequently, if at all, but this provides an escape mechanism for + newer Ruffle sources to upgrade older installations.

      +
      +

      Returns string

      +

      The version of this public API.

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    init

    +
      +
    • init(): void
      • +
    +
      +
    • + +
      +
      +

      Negotiate and start Ruffle.

      +
      +

      This function reads the config parameter to determine which polyfills + should be enabled. If the configuration parameter is missing, then we + use a built-in set of defaults sufficient to fool sites with static + content and weak plugin detection.

      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    local

    + +
      +
    • + +
      +
      +

      Look up the newest Ruffle version with the exact same version as the + local source, if it's installed. Otherwise, use the latest version.

      +
      +
      +

      Returns null | SourceAPI

      +

      An instance of the Source API

      +
      • +
    +
    +
    + +

    localCompatible

    + +
      +
    • + +
      +
      +

      Look up the newest Ruffle version compatible with the local source, if + it's installed. Otherwise, use the latest version.

      +
      +
      +

      Returns null | SourceAPI

      +

      An instance of the Source API

      +
      • +
    +
    +
    + +

    newest

    + + +
    +
    + +

    newestSourceName

    +
      +
    • newestSourceName(): null | string
      • +
    +
      +
    • + +
      +
      +

      Determine the name of the newest registered source in the Public API.

      +
      +
      +

      Returns null | string

      +

      The name of the source, or null if no source + has yet to be registered.

      +
      • +
    +
    +
    + +

    registerSource

    +
      +
    • registerSource(name: string, api: SourceAPI): void
      • +
    +
      +
    • + +
      +
      +

      Register a given source with the Ruffle Public API.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +
        +

        The name of the source.

        +
        +
        • +
      • +
        api: SourceAPI
        +
        +

        The public API object. This must conform to the shape + of SourceAPI.

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    satisfying

    +
      +
    • satisfying(ver_requirement: string): null | SourceAPI
      • +
    +
      +
    • + +
      +
      +

      Look up a specific Ruffle version (or any version satisfying a given set + of requirements) and return it's API.

      +
      +
      +

      Parameters

      +
        +
      • +
        ver_requirement: string
        +
        +

        A set of semantic version requirement + strings that the player version must satisfy.

        +
        +
        • +
      +

      Returns null | SourceAPI

      +

      An instance of the Source API, if one or more + sources satisfied the requirement.

      +
      • +
    +
    +
    + +

    Static negotiate

    +
      +
    • negotiate(prevRuffle: null | PublicAPI | Record<string, unknown>, sourceName: undefined | string, sourceAPI: undefined | SourceAPI): PublicAPI
      • +
    +
      +
    • + +
      +
      +

      Join a source into the public API, if it doesn't already exist.

      +
      +
      +

      Parameters

      +
        +
      • +
        prevRuffle: null | PublicAPI | Record<string, unknown>
        +
        +

        The previous iteration of the Ruffle API.

        +

        The prevRuffle param lists the previous object in the RufflePlayer + slot. We perform some checks to see if this is a Ruffle public API or a + conflicting object. If this is conflicting, then a new public API will + be constructed (see the constructor information for what happens to + prevRuffle).

        +

        Note that Public API upgrades are deliberately not enabled in this + version of Ruffle, since there is no Public API to upgrade from.

        +
        +
        • +
      • +
        sourceName: undefined | string
        +
        +

        The name of this particular + Ruffle source.

        +
        +
        • +
      • +
        sourceAPI: undefined | SourceAPI
        +
        +

        The Ruffle source to add.

        +

        If both parameters are provided they will be used to define a new Ruffle + source to register with the public API.

        +
        +
        • +
      +

      Returns PublicAPI

      +

      The Ruffle Public API.

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    +
      +
    • Property
      • +
    +
      +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + \ No newline at end of file diff --git a/master/classes/ruffleembed.html b/master/classes/ruffleembed.html new file mode 100644 index 000000000..1da71e236 --- /dev/null +++ b/master/classes/ruffleembed.html @@ -0,0 +1,6486 @@ + + + + + + RuffleEmbed | ruffle-core + + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class RuffleEmbed

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    A polyfill html element.

    +
    +

    This specific class tries to polyfill existing <embed> tags, + and should not be used. Prefer RufflePlayer instead.

    +
    +
    internal
    +
    +
    +
    +
    +
    +

    Hierarchy

    + +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Properties

    + +
    +
    +

    Accessors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Properties

    +
    + +

    Readonly ATTRIBUTE_NODE

    +
    ATTRIBUTE_NODE: number
    + +
    +
    + +

    Readonly CDATA_SECTION_NODE

    +
    CDATA_SECTION_NODE: number
    + +
    +
    +

    node is a CDATASection node.

    +
    +
    +
    +
    + +

    Readonly COMMENT_NODE

    +
    COMMENT_NODE: number
    + +
    +
    +

    node is a Comment node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_FRAGMENT_NODE

    +
    DOCUMENT_FRAGMENT_NODE: number
    + +
    +
    +

    node is a DocumentFragment node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_NODE

    +
    DOCUMENT_NODE: number
    + +
    +
    +

    node is a document.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_CONTAINED_BY

    +
    DOCUMENT_POSITION_CONTAINED_BY: number
    + +
    +
    +

    Set when other is a descendant of node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_CONTAINS

    +
    DOCUMENT_POSITION_CONTAINS: number
    + +
    +
    +

    Set when other is an ancestor of node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_DISCONNECTED

    +
    DOCUMENT_POSITION_DISCONNECTED: number
    + +
    +
    +

    Set when node and other are not in the same tree.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_FOLLOWING

    +
    DOCUMENT_POSITION_FOLLOWING: number
    + +
    +
    +

    Set when other is following node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

    +
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number
    + +
    +
    + +

    Readonly DOCUMENT_POSITION_PRECEDING

    +
    DOCUMENT_POSITION_PRECEDING: number
    + +
    +
    +

    Set when other is preceding node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_TYPE_NODE

    +
    DOCUMENT_TYPE_NODE: number
    + +
    +
    +

    node is a doctype.

    +
    +
    +
    +
    + +

    Readonly ELEMENT_NODE

    +
    ELEMENT_NODE: number
    + +
    +
    +

    node is an element.

    +
    +
    +
    +
    + +

    Readonly ENTITY_NODE

    +
    ENTITY_NODE: number
    + +
    +
    + +

    Readonly ENTITY_REFERENCE_NODE

    +
    ENTITY_REFERENCE_NODE: number
    + +
    +
    + +

    Readonly NOTATION_NODE

    +
    NOTATION_NODE: number
    + +
    +
    + +

    Readonly PROCESSING_INSTRUCTION_NODE

    +
    PROCESSING_INSTRUCTION_NODE: number
    + +
    +
    +

    node is a ProcessingInstruction node.

    +
    +
    +
    +
    + +

    Readonly TEXT_NODE

    +
    TEXT_NODE: number
    + +
    +
    +

    node is a Text node.

    +
    +
    +
    +
    + +

    accessKey

    +
    accessKey: string
    + +
    +
    + +

    Readonly accessKeyLabel

    +
    accessKeyLabel: string
    + +
    +
    + +

    allowScriptAccess

    +
    allowScriptAccess: boolean
    + +
    +
    +

    If set to true, the movie is allowed to interact with the page through + JavaScript, using a flash concept called ExternalInterface.

    +
    +

    This should only be enabled for movies you trust.

    +
    +
    +
    + +

    Readonly assignedSlot

    +
    assignedSlot: null | HTMLSlotElement
    + +
    +
    + +

    Readonly attributes

    +
    attributes: NamedNodeMap
    + +
    +
    + +

    autocapitalize

    +
    autocapitalize: string
    + +
    +
    + +

    autofocus

    +
    autofocus: boolean
    + +
    +
    + +

    Readonly baseURI

    +
    baseURI: string
    + +
    +
    +

    Returns node's node document's document base URL.

    +
    +
    +
    +
    + +

    Readonly childElementCount

    +
    childElementCount: number
    + +
    +
    + +

    Readonly childNodes

    +
    childNodes: NodeListOf<ChildNode>
    + +
    +
    +

    Returns the children.

    +
    +
    +
    +
    + +

    Readonly children

    +
    children: HTMLCollection
    + +
    +
    +

    Returns the child elements.

    +
    +
    +
    +
    + +

    Readonly classList

    +
    classList: DOMTokenList
    + +
    +
    +

    Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

    +
    +
    +
    +
    + +

    className

    +
    className: string
    + +
    +
    +

    Returns the value of element's class content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    Readonly clientHeight

    +
    clientHeight: number
    + +
    +
    + +

    Readonly clientLeft

    +
    clientLeft: number
    + +
    +
    + +

    Readonly clientTop

    +
    clientTop: number
    + +
    +
    + +

    Readonly clientWidth

    +
    clientWidth: number
    + +
    +
    + +

    config

    +
    config: Config = ...
    + +
    +
    +

    Any configuration that should apply to this specific player. + This will be defaulted with any global configuration.

    +
    +
    +
    +
    + +

    contentEditable

    +
    contentEditable: string
    + +
    +
    + +

    Readonly dataset

    +
    dataset: DOMStringMap
    + +
    +
    + +

    dir

    +
    dir: string
    + +
    +
    + +

    draggable

    +
    draggable: boolean
    + +
    +
    + +

    enterKeyHint

    +
    enterKeyHint: string
    + +
    +
    + +

    Readonly firstChild

    +
    firstChild: null | ChildNode
    + +
    +
    +

    Returns the first child.

    +
    +
    +
    +
    + +

    Readonly firstElementChild

    +
    firstElementChild: null | Element
    + +
    +
    +

    Returns the first child that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    hidden

    +
    hidden: boolean
    + +
    +
    + +

    id

    +
    id: string
    + +
    +
    +

    Returns the value of element's id content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    innerHTML

    +
    innerHTML: string
    + +
    +
    + +

    innerText

    +
    innerText: string
    + +
    +
    + +

    inputMode

    +
    inputMode: string
    + +
    +
    + +

    Readonly isConnected

    +
    isConnected: boolean
    + +
    +
    +

    Returns true if node is connected and false otherwise.

    +
    +
    +
    +
    + +

    Readonly isContentEditable

    +
    isContentEditable: boolean
    + +
    +
    + +

    lang

    +
    lang: string
    + +
    +
    + +

    Readonly lastChild

    +
    lastChild: null | ChildNode
    + +
    +
    +

    Returns the last child.

    +
    +
    +
    +
    + +

    Readonly lastElementChild

    +
    lastElementChild: null | Element
    + +
    +
    +

    Returns the last child that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly localName

    +
    localName: string
    + +
    +
    +

    Returns the local name.

    +
    +
    +
    +
    + +

    Readonly namespaceURI

    +
    namespaceURI: null | string
    + +
    +
    +

    Returns the namespace.

    +
    +
    +
    +
    + +

    Readonly nextElementSibling

    +
    nextElementSibling: null | Element
    + +
    +
    +

    Returns the first following sibling that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly nextSibling

    +
    nextSibling: null | ChildNode
    + +
    +
    +

    Returns the next sibling.

    +
    +
    +
    +
    + +

    Readonly nodeName

    +
    nodeName: string
    + +
    +
    +

    Returns a string appropriate for the type of node.

    +
    +
    +
    +
    + +

    Readonly nodeType

    +
    nodeType: number
    + +
    +
    +

    Returns the type of node.

    +
    +
    +
    +
    + +

    nodeValue

    +
    nodeValue: null | string
    + +
    +
    + +

    Optional nonce

    +
    nonce: undefined | string
    + +
    +
    + +

    Readonly offsetHeight

    +
    offsetHeight: number
    + +
    +
    + +

    Readonly offsetLeft

    +
    offsetLeft: number
    + +
    +
    + +

    Readonly offsetParent

    +
    offsetParent: null | Element
    + +
    +
    + +

    Readonly offsetTop

    +
    offsetTop: number
    + +
    +
    + +

    Readonly offsetWidth

    +
    offsetWidth: number
    + +
    +
    + +

    onabort

    +
    onabort: null | ((ev: UIEvent) => any)
    + +
    +
    +

    Fires when the user aborts the download.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onanimationcancel

    +
    onanimationcancel: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationend

    +
    onanimationend: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationiteration

    +
    onanimationiteration: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationstart

    +
    onanimationstart: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onauxclick

    +
    onauxclick: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onblur

    +
    onblur: null | ((ev: FocusEvent) => any)
    + +
    +
    +

    Fires when the object loses the input focus.

    +
    +
    +
    param
    +

    The focus event.

    +
    +
    +
    +
    +
    + +

    oncancel

    +
    oncancel: null | ((ev: Event) => any)
    + +
    +
    + +

    oncanplay

    +
    oncanplay: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback is possible, but would require further buffering.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    oncanplaythrough

    +
    oncanplaythrough: null | ((ev: Event) => any)
    + +
    +
    + +

    onchange

    +
    onchange: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the contents of the object or selection have changed.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onclick

    +
    onclick: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the left mouse button on the object

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onclose

    +
    onclose: null | ((ev: Event) => any)
    + +
    +
    + +

    oncontextmenu

    +
    oncontextmenu: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the right mouse button in the client area, opening the context menu.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    oncopy

    +
    oncopy: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    oncuechange

    +
    oncuechange: null | ((ev: Event) => any)
    + +
    +
    + +

    oncut

    +
    oncut: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    ondblclick

    +
    ondblclick: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user double-clicks the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    ondrag

    +
    ondrag: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object continuously during a drag operation.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragend

    +
    ondragend: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object when the user releases the mouse at the close of a drag operation.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragenter

    +
    ondragenter: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target element when the user drags the object to a valid drop target.

    +
    +
    +
    param
    +

    The drag event.

    +
    +
    +
    +
    +
    + +

    ondragexit

    +
    ondragexit: null | ((ev: Event) => any)
    + +
    +
    + +

    ondragleave

    +
    ondragleave: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

    +
    +
    +
    param
    +

    The drag event.

    +
    +
    +
    +
    +
    + +

    ondragover

    +
    ondragover: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target element continuously while the user drags the object over a valid drop target.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragstart

    +
    ondragstart: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object when the user starts to drag a text selection or selected object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondrop

    +
    ondrop: null | ((ev: DragEvent) => any)
    + +
    +
    + +

    ondurationchange

    +
    ondurationchange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the duration attribute is updated.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onemptied

    +
    onemptied: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the media element is reset to its initial state.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onended

    +
    onended: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the end of playback is reached.

    +
    +
    +
    param
    +

    The event

    +
    +
    +
    +
    +
    + +

    onerror

    +
    onerror: OnErrorEventHandler
    + +
    +
    +

    Fires when an error occurs during object loading.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onfocus

    +
    onfocus: null | ((ev: FocusEvent) => any)
    + +
    +
    +

    Fires when the object receives focus.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onfullscreenchange

    +
    onfullscreenchange: null | ((ev: Event) => any)
    + +
    +
    + +

    onfullscreenerror

    +
    onfullscreenerror: null | ((ev: Event) => any)
    + +
    +
    + +

    ongotpointercapture

    +
    ongotpointercapture: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    oninput

    +
    oninput: null | ((ev: Event) => any)
    + +
    +
    + +

    oninvalid

    +
    oninvalid: null | ((ev: Event) => any)
    + +
    +
    + +

    onkeydown

    +
    onkeydown: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user presses a key.

    +
    +
    +
    param
    +

    The keyboard event

    +
    +
    +
    +
    +
    + +

    onkeypress

    +
    onkeypress: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user presses an alphanumeric key.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onkeyup

    +
    onkeyup: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user releases a key.

    +
    +
    +
    param
    +

    The keyboard event

    +
    +
    +
    +
    +
    + +

    onload

    +
    onload: null | ((ev: Event) => any)
    + +
    +
    +

    Fires immediately after the browser loads the object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadeddata

    +
    onloadeddata: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when media data is loaded at the current playback position.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadedmetadata

    +
    onloadedmetadata: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the duration and dimensions of the media have been determined.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadstart

    +
    onloadstart: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when Internet Explorer begins looking for media data.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onlostpointercapture

    +
    onlostpointercapture: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onmousedown

    +
    onmousedown: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the object with either mouse button.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseenter

    +
    onmouseenter: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onmouseleave

    +
    onmouseleave: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onmousemove

    +
    onmousemove: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse over the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseout

    +
    onmouseout: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse pointer outside the boundaries of the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseover

    +
    onmouseover: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse pointer into the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseup

    +
    onmouseup: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user releases a mouse button while the mouse is over the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onpaste

    +
    onpaste: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    onpause

    +
    onpause: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback is paused.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onplay

    +
    onplay: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the play method is requested.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onplaying

    +
    onplaying: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the audio or video has started playing.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onpointercancel

    +
    onpointercancel: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerdown

    +
    onpointerdown: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerenter

    +
    onpointerenter: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerleave

    +
    onpointerleave: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointermove

    +
    onpointermove: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerout

    +
    onpointerout: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerover

    +
    onpointerover: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerup

    +
    onpointerup: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onprogress

    +
    onprogress: null | ((ev: ProgressEvent<EventTarget>) => any)
    + +
    +
    +

    Occurs to indicate progress while downloading media data.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onratechange

    +
    onratechange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the playback rate is increased or decreased.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onreset

    +
    onreset: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the user resets a form.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onresize

    +
    onresize: null | ((ev: UIEvent) => any)
    + +
    +
    + +

    onscroll

    +
    onscroll: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the user repositions the scroll box in the scroll bar on the object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onsecuritypolicyviolation

    +
    onsecuritypolicyviolation: null | ((ev: SecurityPolicyViolationEvent) => any)
    + +
    +
    + +

    onseeked

    +
    onseeked: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the seek operation ends.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onseeking

    +
    onseeking: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the current playback position is moved.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onselect

    +
    onselect: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the current selection changes.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onselectionchange

    +
    onselectionchange: null | ((ev: Event) => any)
    + +
    +
    + +

    onselectstart

    +
    onselectstart: null | ((ev: Event) => any)
    + +
    +
    + +

    onstalled

    +
    onstalled: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the download has stopped.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onsubmit

    +
    onsubmit: null | ((ev: Event) => any)
    + +
    +
    + +

    onsuspend

    +
    onsuspend: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs if the load operation has been intentionally halted.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ontimeupdate

    +
    ontimeupdate: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs to indicate the current playback position.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ontoggle

    +
    ontoggle: null | ((ev: Event) => any)
    + +
    +
    + +

    Optional ontouchcancel

    +
    ontouchcancel: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchend

    +
    ontouchend: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchmove

    +
    ontouchmove: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchstart

    +
    ontouchstart: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    ontransitioncancel

    +
    ontransitioncancel: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionend

    +
    ontransitionend: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionrun

    +
    ontransitionrun: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionstart

    +
    ontransitionstart: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    onvolumechange

    +
    onvolumechange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the volume is changed, or playback is muted or unmuted.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onwaiting

    +
    onwaiting: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback stops because the next frame of a video resource is not available.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onwheel

    +
    onwheel: null | ((ev: WheelEvent) => any)
    + +
    +
    + +

    outerHTML

    +
    outerHTML: string
    + +
    +
    + +

    Readonly ownerDocument

    +
    ownerDocument: Document
    + +
    +
    + +

    Readonly parentElement

    +
    parentElement: null | HTMLElement
    + +
    +
    +

    Returns the parent element.

    +
    +
    +
    +
    + +

    Readonly parentNode

    +
    parentNode: null | (Node & ParentNode)
    + +
    +
    +

    Returns the parent.

    +
    +
    +
    +
    + +

    Readonly prefix

    +
    prefix: null | string
    + +
    +
    +

    Returns the namespace prefix.

    +
    +
    +
    +
    + +

    Readonly previousElementSibling

    +
    previousElementSibling: null | Element
    + +
    +
    +

    Returns the first preceding sibling that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly previousSibling

    +
    previousSibling: null | ChildNode
    + +
    +
    +

    Returns the previous sibling.

    +
    +
    +
    +
    + +

    Readonly scrollHeight

    +
    scrollHeight: number
    + +
    +
    + +

    scrollLeft

    +
    scrollLeft: number
    + +
    +
    + +

    scrollTop

    +
    scrollTop: number
    + +
    +
    + +

    Readonly scrollWidth

    +
    scrollWidth: number
    + +
    +
    + +

    Readonly shadowRoot

    +
    shadowRoot: null | ShadowRoot
    + +
    +
    +

    Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

    +
    +
    +
    +
    + +

    slot

    +
    slot: string
    + +
    +
    +

    Returns the value of element's slot content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    spellcheck

    +
    spellcheck: boolean
    + +
    +
    + +

    Readonly style

    +
    style: CSSStyleDeclaration
    + +
    +
    + +

    tabIndex

    +
    tabIndex: number
    + +
    +
    + +

    Readonly tagName

    +
    tagName: string
    + +
    +
    +

    Returns the HTML-uppercased qualified name.

    +
    +
    +
    +
    + +

    textContent

    +
    textContent: null | string
    + +
    +
    + +

    title

    +
    title: string
    + +
    +
    + +

    translate

    +
    translate: boolean
    + +
    +
    + +

    Optional webkitRequestFullScreen

    +
    webkitRequestFullScreen: undefined | (() => void)
    + +
    +
    +
    +

    Accessors

    +
    + +

    fullscreenEnabled

    +
      +
    • get fullscreenEnabled(): boolean
      • +
    + +
    +
    + +

    isFullscreen

    +
      +
    • get isFullscreen(): boolean
      • +
    + +
    +
    + +

    traceObserver

    +
      +
    • set traceObserver(observer: null | ((message: string) => void)): void
      • +
    +
      +
    • + +
      +
      +

      Sets a trace observer on this flash player.

      +
      +

      The observer will be called, as a function, for each message that the playing movie will "trace" (output).

      +
      +

      Parameters

      +
        +
      • +
        observer: null | ((message: string) => void)
        +
        +
        +

        The observer that will be called for each trace.

        +
        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    addEventListener

    +
      +
    • addEventListener<K>(type: K, listener: (ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
      • +
    • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

        +
        • +
      +

      Parameters

      +
        +
      • +
        type: K
        +
        • +
      • +
        listener: (ev: HTMLElementEventMap[K]) => any
        +
          +
        • +
            +
          • (ev: HTMLElementEventMap[K]): any
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              ev: HTMLElementEventMap[K]
              +
              • +
            +

            Returns any

            +
            • +
          +
          • +
        +
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      • +
        listener: EventListenerOrEventListenerObject
        +
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    after

    +
      +
    • after(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    animate

    +
      +
    • animate(keyframes: null | Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        keyframes: null | Keyframe[] | PropertyIndexedKeyframes
        +
        • +
      • +
        Optional options: number | KeyframeAnimationOptions
        +
        • +
      +

      Returns Animation

      +
      • +
    +
    +
    + +

    append

    +
      +
    • append(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    appendChild

    +
      +
    • appendChild<T>(newChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    attachShadow

    +
      +
    • attachShadow(init: ShadowRootInit): ShadowRoot
      • +
    +
      +
    • + +
      +
      +

      Creates a shadow root for element and returns it.

      +
      +
      +

      Parameters

      +
        +
      • +
        init: ShadowRootInit
        +
        • +
      +

      Returns ShadowRoot

      +
      • +
    +
    +
    + +

    before

    +
      +
    • before(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    blur

    +
      +
    • blur(): void
      • +
    +
      +
    • + +

      Returns void

      +
      • +
    +
    +
    + +

    click

    +
      +
    • click(): void
      • +
    +
      +
    • + +

      Returns void

      +
      • +
    +
    +
    + +

    cloneNode

    +
      +
    • cloneNode(deep?: boolean): Node
      • +
    +
      +
    • + +
      +
      +

      Returns a copy of node. If deep is true, the copy also includes the node's descendants.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional deep: boolean
        +
        • +
      +

      Returns Node

      +
      • +
    +
    +
    + +

    closest

    +
      +
    • closest<K>(selector: K): null | HTMLElementTagNameMap[K]
      • +
    • closest<K>(selector: K): null | SVGElementTagNameMap[K]
      • +
    • closest<E>(selector: string): null | E
      • +
    +
      +
    • + +
      +
      +

      Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: K
        +
        • +
      +

      Returns null | HTMLElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: K
        +
        • +
      +

      Returns null | SVGElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: string
        +
        • +
      +

      Returns null | E

      +
      • +
    +
    +
    + +

    compareDocumentPosition

    +
      +
    • compareDocumentPosition(other: Node): number
      • +
    +
      +
    • + +
      +
      +

      Returns a bitmask indicating the position of other relative to node.

      +
      +
      +

      Parameters

      +
        +
      • +
        other: Node
        +
        • +
      +

      Returns number

      +
      • +
    +
    +
    + +

    contains

    +
      +
    • contains(other: null | Node): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if other is an inclusive descendant of node, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        other: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    dispatchEvent

    +
      +
    • dispatchEvent(event: Event): boolean
      • +
    +
      +
    • + +
      +
      +

      Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        event: Event
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    displayMessage

    +
      +
    • displayMessage(message: string): void
      • +
    + +
    +
    + +

    enterFullscreen

    +
      +
    • enterFullscreen(): void
      • +
    + +
    +
    + +

    exitFullscreen

    +
      +
    • exitFullscreen(): void
      • +
    + +
    +
    + +

    focus

    +
      +
    • focus(options?: FocusOptions): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: FocusOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    getAnimations

    +
      +
    • getAnimations(): Animation[]
      • +
    +
      +
    • + +

      Returns Animation[]

      +
      • +
    +
    +
    + +

    getAttribute

    +
      +
    • getAttribute(qualifiedName: string): null | string
      • +
    +
      +
    • + +
      +
      +

      Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    getAttributeNS

    +
      +
    • getAttributeNS(namespace: null | string, localName: string): null | string
      • +
    +
      +
    • + +
      +
      +

      Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    getAttributeNames

    +
      +
    • getAttributeNames(): string[]
      • +
    +
      +
    • + +
      +
      +

      Returns the qualified names of all element's attributes. Can contain duplicates.

      +
      +
      +

      Returns string[]

      +
      • +
    +
    +
    + +

    getAttributeNode

    +
      +
    • getAttributeNode(qualifiedName: string): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    getAttributeNodeNS

    +
      +
    • getAttributeNodeNS(namespace: null | string, localName: string): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    getBoundingClientRect

    +
      +
    • getBoundingClientRect(): DOMRect
      • +
    + +
    +
    + +

    getClientRects

    +
      +
    • getClientRects(): DOMRectList
      • +
    +
      +
    • + +

      Returns DOMRectList

      +
      • +
    +
    +
    + +

    getElementsByClassName

    +
      +
    • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +
      +
      +

      Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

      +
      +
      +

      Parameters

      +
        +
      • +
        classNames: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getElementsByTagName

    +
      +
    • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
      • +
    • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
      • +
    • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        qualifiedName: K
        +
        • +
      +

      Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        qualifiedName: K
        +
        • +
      +

      Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getElementsByTagNameNS

    +
      +
    • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
      • +
    • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
      • +
    • getElementsByTagNameNS(namespaceURI: string, localName: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: "http://www.w3.org/1999/xhtml"
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<HTMLElement>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: "http://www.w3.org/2000/svg"
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<SVGElement>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getRootNode

    +
      +
    • getRootNode(options?: GetRootNodeOptions): Node
      • +
    +
      +
    • + +
      +
      +

      Returns node's root.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional options: GetRootNodeOptions
        +
        • +
      +

      Returns Node

      +
      • +
    +
    +
    + +

    hasAttribute

    +
      +
    • hasAttribute(qualifiedName: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasAttributeNS

    +
      +
    • hasAttributeNS(namespace: null | string, localName: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has an attribute whose namespace is namespace and local name is localName.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasAttributes

    +
      +
    • hasAttributes(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has attributes, and false otherwise.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasChildNodes

    +
      +
    • hasChildNodes(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns whether node has children.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasPointerCapture

    +
      +
    • hasPointerCapture(pointerId: number): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    insertAdjacentElement

    +
      +
    • insertAdjacentElement(position: InsertPosition, insertedElement: Element): null | Element
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        position: InsertPosition
        +
        • +
      • +
        insertedElement: Element
        +
        • +
      +

      Returns null | Element

      +
      • +
    +
    +
    + +

    insertAdjacentHTML

    +
      +
    • insertAdjacentHTML(where: InsertPosition, html: string): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        where: InsertPosition
        +
        • +
      • +
        html: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    insertAdjacentText

    +
      +
    • insertAdjacentText(where: InsertPosition, text: string): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        where: InsertPosition
        +
        • +
      • +
        text: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    insertBefore

    +
      +
    • insertBefore<T>(newChild: T, refChild: null | Node): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: T
        +
        • +
      • +
        refChild: null | Node
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    isDefaultNamespace

    +
      +
    • isDefaultNamespace(namespace: null | string): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isEqualNode

    +
      +
    • isEqualNode(otherNode: null | Node): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns whether node and otherNode have the same properties.

      +
      +
      +

      Parameters

      +
        +
      • +
        otherNode: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSameNode

    +
      +
    • isSameNode(otherNode: null | Node): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        otherNode: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    load

    + +
      +
    • + +
      +
      +

      Loads a specified movie into this player.

      +
      +

      This will replace any existing movie that may be playing.

      +
      +

      Parameters

      +
        +
      • +
        options: string | URLLoadOptions | DataLoadOptions
        +
        +

        One of the following:

        +
          +
        • A URL, passed as a string, which will load a URL with default options.
          • +
        • A URLLoadOptions object, to load a URL with options.
          • +
        • A DataLoadOptions object, to load data with options.
          • +
        +

        The options will be defaulted by the config field, which itself + is defaulted by a global window.RufflePlayer.config.

        +
        +
        • +
      +

      Returns Promise<void>

      +
      • +
    +
    +
    + +

    lookupNamespaceURI

    +
      +
    • lookupNamespaceURI(prefix: null | string): null | string
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        prefix: null | string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    lookupPrefix

    +
      +
    • lookupPrefix(namespace: null | string): null | string
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    matches

    +
      +
    • matches(selectors: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if matching selectors against element's root yields element, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    msGetRegionContent

    +
      +
    • msGetRegionContent(): any
      • +
    + +
    +
    + +

    normalize

    +
      +
    • normalize(): void
      • +
    +
      +
    • + +
      +
      +

      Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

      +
      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    panic

    +
      +
    • panic(error: null | Error): void
      • +
    +
      +
    • + +
      +
      +

      Panics this specific player, forcefully destroying all resources and displays an error message to the user.

      +
      +

      This should be called when something went absolutely, incredibly and disastrously wrong and there is no chance + of recovery.

      +

      Ruffle will attempt to isolate all damage to this specific player instance, but no guarantees can be made if there + was a core issue which triggered the panic. If Ruffle is unable to isolate the cause to a specific player, then + all players will panic and Ruffle will become "poisoned" - no more players will run on this page until it is + reloaded fresh.

      +
      +

      Parameters

      +
        +
      • +
        error: null | Error
        +
        +

        The error, if any, that triggered this panic.

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    pause

    +
      +
    • pause(): void
      • +
    +
      +
    • + +
      +
      +

      Pauses this player.

      +
      +

      No more frames, scripts or sounds will be executed. + This movie will be considered inactive and will not wake up until resumed.

      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    play

    +
      +
    • play(): void
      • +
    + +
    +
    + +

    prepend

    +
      +
    • prepend(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    querySelector

    +
      +
    • querySelector<K>(selectors: K): null | HTMLElementTagNameMap[K]
      • +
    • querySelector<K>(selectors: K): null | SVGElementTagNameMap[K]
      • +
    • querySelector<E>(selectors: string): null | E
      • +
    +
      +
    • + +
      +
      +

      Returns the first element that is a descendant of node that matches selectors.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns null | HTMLElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns null | SVGElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns null | E

      +
      • +
    +
    +
    + +

    querySelectorAll

    +
      +
    • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
      • +
    • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
      • +
    • querySelectorAll<E>(selectors: string): NodeListOf<E>
      • +
    +
      +
    • + +
      +
      +

      Returns all element descendants of node that match selectors.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns NodeListOf<HTMLElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns NodeListOf<SVGElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns NodeListOf<E>

      +
      • +
    +
    +
    + +

    releasePointerCapture

    +
      +
    • releasePointerCapture(pointerId: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    remove

    +
      +
    • remove(): void
      • +
    +
      +
    • + +
      +
      +

      Removes node.

      +
      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttribute

    +
      +
    • removeAttribute(qualifiedName: string): void
      • +
    +
      +
    • + +
      +
      +

      Removes element's first attribute whose qualified name is qualifiedName.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttributeNS

    +
      +
    • removeAttributeNS(namespace: null | string, localName: string): void
      • +
    +
      +
    • + +
      +
      +

      Removes element's attribute whose namespace is namespace and local name is localName.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttributeNode

    +
      +
    • removeAttributeNode(attr: Attr): Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns Attr

      +
      • +
    +
    +
    + +

    removeChild

    +
      +
    • removeChild<T>(oldChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        oldChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    removeEventListener

    +
      +
    • removeEventListener<K>(type: K, listener: (ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void
      • +
    • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

        +
        • +
      +

      Parameters

      +
        +
      • +
        type: K
        +
        • +
      • +
        listener: (ev: HTMLElementEventMap[K]) => any
        +
          +
        • +
            +
          • (ev: HTMLElementEventMap[K]): any
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              ev: HTMLElementEventMap[K]
              +
              • +
            +

            Returns any

            +
            • +
          +
          • +
        +
        • +
      • +
        Optional options: boolean | EventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      • +
        listener: EventListenerOrEventListenerObject
        +
        • +
      • +
        Optional options: boolean | EventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    replaceChild

    +
      +
    • replaceChild<T>(newChild: Node, oldChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: Node
        +
        • +
      • +
        oldChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    replaceWith

    +
      +
    • replaceWith(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    requestFullscreen

    +
      +
    • requestFullscreen(options?: FullscreenOptions): Promise<void>
      • +
    +
      +
    • + +
      +
      +

      Displays element fullscreen and resolves promise when done.

      +
      +

      When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

      +
      +

      Parameters

      +
        +
      • +
        Optional options: FullscreenOptions
        +
        • +
      +

      Returns Promise<void>

      +
      • +
    +
    +
    + +

    requestPointerLock

    +
      +
    • requestPointerLock(): void
      • +
    + +
    +
    + +

    scroll

    +
      +
    • scroll(options?: ScrollToOptions): void
      • +
    • scroll(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollBy

    +
      +
    • scrollBy(options?: ScrollToOptions): void
      • +
    • scrollBy(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollIntoView

    +
      +
    • scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional arg: boolean | ScrollIntoViewOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollTo

    +
      +
    • scrollTo(options?: ScrollToOptions): void
      • +
    • scrollTo(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttribute

    +
      +
    • setAttribute(qualifiedName: string, value: string): void
      • +
    +
      +
    • + +
      +
      +

      Sets the value of element's first attribute whose qualified name is qualifiedName to value.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      • +
        value: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttributeNS

    +
      +
    • setAttributeNS(namespace: null | string, qualifiedName: string, value: string): void
      • +
    +
      +
    • + +
      +
      +

      Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        qualifiedName: string
        +
        • +
      • +
        value: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttributeNode

    +
      +
    • setAttributeNode(attr: Attr): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    setAttributeNodeNS

    +
      +
    • setAttributeNodeNS(attr: Attr): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    setPointerCapture

    +
      +
    • setPointerCapture(pointerId: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    toggleAttribute

    +
      +
    • toggleAttribute(qualifiedName: string, force?: boolean): boolean
      • +
    +
      +
    • + +
      +
      +

      If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

      +
      +

      Returns true if qualifiedName is now present, and false otherwise.

      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      • +
        Optional force: boolean
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    webkitMatchesSelector

    +
      +
    • webkitMatchesSelector(selectors: string): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    Static fromNativeEmbedElement

    +
      +
    • fromNativeEmbedElement(elem: HTMLElement): RuffleEmbed
      • +
    +
      +
    • + +
      +
      +

      Creates a RuffleEmbed that will polyfill and replace the given element.

      +
      +
      +

      Parameters

      +
        +
      • +
        elem: HTMLElement
        +
        +

        Element to replace.

        +
        +
        • +
      +

      Returns RuffleEmbed

      +

      Created RuffleEmbed.

      +
      • +
    +
    +
    + +

    Static isInterdictable

    +
      +
    • isInterdictable(elem: HTMLElement): boolean
      • +
    +
      +
    • + +
      +
      +

      Checks if the given element may be polyfilled with this one.

      +
      +
      +

      Parameters

      +
        +
      • +
        elem: HTMLElement
        +
        +

        Element to check.

        +
        +
        • +
      +

      Returns boolean

      +

      True if the element looks like a flash embed.

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    +
      +
    • Property
      • +
    +
      +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + \ No newline at end of file diff --git a/master/classes/ruffleobject.html b/master/classes/ruffleobject.html new file mode 100644 index 000000000..ed70fe252 --- /dev/null +++ b/master/classes/ruffleobject.html @@ -0,0 +1,6486 @@ + + + + + + RuffleObject | ruffle-core + + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class RuffleObject

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    A polyfill html element.

    +
    +

    This specific class tries to polyfill existing <object> tags, + and should not be used. Prefer RufflePlayer instead.

    +
    +
    internal
    +
    +
    +
    +
    +
    +

    Hierarchy

    + +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Properties

    + +
    +
    +

    Accessors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Properties

    +
    + +

    Readonly ATTRIBUTE_NODE

    +
    ATTRIBUTE_NODE: number
    + +
    +
    + +

    Readonly CDATA_SECTION_NODE

    +
    CDATA_SECTION_NODE: number
    + +
    +
    +

    node is a CDATASection node.

    +
    +
    +
    +
    + +

    Readonly COMMENT_NODE

    +
    COMMENT_NODE: number
    + +
    +
    +

    node is a Comment node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_FRAGMENT_NODE

    +
    DOCUMENT_FRAGMENT_NODE: number
    + +
    +
    +

    node is a DocumentFragment node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_NODE

    +
    DOCUMENT_NODE: number
    + +
    +
    +

    node is a document.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_CONTAINED_BY

    +
    DOCUMENT_POSITION_CONTAINED_BY: number
    + +
    +
    +

    Set when other is a descendant of node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_CONTAINS

    +
    DOCUMENT_POSITION_CONTAINS: number
    + +
    +
    +

    Set when other is an ancestor of node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_DISCONNECTED

    +
    DOCUMENT_POSITION_DISCONNECTED: number
    + +
    +
    +

    Set when node and other are not in the same tree.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_FOLLOWING

    +
    DOCUMENT_POSITION_FOLLOWING: number
    + +
    +
    +

    Set when other is following node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

    +
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number
    + +
    +
    + +

    Readonly DOCUMENT_POSITION_PRECEDING

    +
    DOCUMENT_POSITION_PRECEDING: number
    + +
    +
    +

    Set when other is preceding node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_TYPE_NODE

    +
    DOCUMENT_TYPE_NODE: number
    + +
    +
    +

    node is a doctype.

    +
    +
    +
    +
    + +

    Readonly ELEMENT_NODE

    +
    ELEMENT_NODE: number
    + +
    +
    +

    node is an element.

    +
    +
    +
    +
    + +

    Readonly ENTITY_NODE

    +
    ENTITY_NODE: number
    + +
    +
    + +

    Readonly ENTITY_REFERENCE_NODE

    +
    ENTITY_REFERENCE_NODE: number
    + +
    +
    + +

    Readonly NOTATION_NODE

    +
    NOTATION_NODE: number
    + +
    +
    + +

    Readonly PROCESSING_INSTRUCTION_NODE

    +
    PROCESSING_INSTRUCTION_NODE: number
    + +
    +
    +

    node is a ProcessingInstruction node.

    +
    +
    +
    +
    + +

    Readonly TEXT_NODE

    +
    TEXT_NODE: number
    + +
    +
    +

    node is a Text node.

    +
    +
    +
    +
    + +

    accessKey

    +
    accessKey: string
    + +
    +
    + +

    Readonly accessKeyLabel

    +
    accessKeyLabel: string
    + +
    +
    + +

    allowScriptAccess

    +
    allowScriptAccess: boolean
    + +
    +
    +

    If set to true, the movie is allowed to interact with the page through + JavaScript, using a flash concept called ExternalInterface.

    +
    +

    This should only be enabled for movies you trust.

    +
    +
    +
    + +

    Readonly assignedSlot

    +
    assignedSlot: null | HTMLSlotElement
    + +
    +
    + +

    Readonly attributes

    +
    attributes: NamedNodeMap
    + +
    +
    + +

    autocapitalize

    +
    autocapitalize: string
    + +
    +
    + +

    autofocus

    +
    autofocus: boolean
    + +
    +
    + +

    Readonly baseURI

    +
    baseURI: string
    + +
    +
    +

    Returns node's node document's document base URL.

    +
    +
    +
    +
    + +

    Readonly childElementCount

    +
    childElementCount: number
    + +
    +
    + +

    Readonly childNodes

    +
    childNodes: NodeListOf<ChildNode>
    + +
    +
    +

    Returns the children.

    +
    +
    +
    +
    + +

    Readonly children

    +
    children: HTMLCollection
    + +
    +
    +

    Returns the child elements.

    +
    +
    +
    +
    + +

    Readonly classList

    +
    classList: DOMTokenList
    + +
    +
    +

    Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

    +
    +
    +
    +
    + +

    className

    +
    className: string
    + +
    +
    +

    Returns the value of element's class content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    Readonly clientHeight

    +
    clientHeight: number
    + +
    +
    + +

    Readonly clientLeft

    +
    clientLeft: number
    + +
    +
    + +

    Readonly clientTop

    +
    clientTop: number
    + +
    +
    + +

    Readonly clientWidth

    +
    clientWidth: number
    + +
    +
    + +

    config

    +
    config: Config = ...
    + +
    +
    +

    Any configuration that should apply to this specific player. + This will be defaulted with any global configuration.

    +
    +
    +
    +
    + +

    contentEditable

    +
    contentEditable: string
    + +
    +
    + +

    Readonly dataset

    +
    dataset: DOMStringMap
    + +
    +
    + +

    dir

    +
    dir: string
    + +
    +
    + +

    draggable

    +
    draggable: boolean
    + +
    +
    + +

    enterKeyHint

    +
    enterKeyHint: string
    + +
    +
    + +

    Readonly firstChild

    +
    firstChild: null | ChildNode
    + +
    +
    +

    Returns the first child.

    +
    +
    +
    +
    + +

    Readonly firstElementChild

    +
    firstElementChild: null | Element
    + +
    +
    +

    Returns the first child that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    hidden

    +
    hidden: boolean
    + +
    +
    + +

    id

    +
    id: string
    + +
    +
    +

    Returns the value of element's id content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    innerHTML

    +
    innerHTML: string
    + +
    +
    + +

    innerText

    +
    innerText: string
    + +
    +
    + +

    inputMode

    +
    inputMode: string
    + +
    +
    + +

    Readonly isConnected

    +
    isConnected: boolean
    + +
    +
    +

    Returns true if node is connected and false otherwise.

    +
    +
    +
    +
    + +

    Readonly isContentEditable

    +
    isContentEditable: boolean
    + +
    +
    + +

    lang

    +
    lang: string
    + +
    +
    + +

    Readonly lastChild

    +
    lastChild: null | ChildNode
    + +
    +
    +

    Returns the last child.

    +
    +
    +
    +
    + +

    Readonly lastElementChild

    +
    lastElementChild: null | Element
    + +
    +
    +

    Returns the last child that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly localName

    +
    localName: string
    + +
    +
    +

    Returns the local name.

    +
    +
    +
    +
    + +

    Readonly namespaceURI

    +
    namespaceURI: null | string
    + +
    +
    +

    Returns the namespace.

    +
    +
    +
    +
    + +

    Readonly nextElementSibling

    +
    nextElementSibling: null | Element
    + +
    +
    +

    Returns the first following sibling that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly nextSibling

    +
    nextSibling: null | ChildNode
    + +
    +
    +

    Returns the next sibling.

    +
    +
    +
    +
    + +

    Readonly nodeName

    +
    nodeName: string
    + +
    +
    +

    Returns a string appropriate for the type of node.

    +
    +
    +
    +
    + +

    Readonly nodeType

    +
    nodeType: number
    + +
    +
    +

    Returns the type of node.

    +
    +
    +
    +
    + +

    nodeValue

    +
    nodeValue: null | string
    + +
    +
    + +

    Optional nonce

    +
    nonce: undefined | string
    + +
    +
    + +

    Readonly offsetHeight

    +
    offsetHeight: number
    + +
    +
    + +

    Readonly offsetLeft

    +
    offsetLeft: number
    + +
    +
    + +

    Readonly offsetParent

    +
    offsetParent: null | Element
    + +
    +
    + +

    Readonly offsetTop

    +
    offsetTop: number
    + +
    +
    + +

    Readonly offsetWidth

    +
    offsetWidth: number
    + +
    +
    + +

    onabort

    +
    onabort: null | ((ev: UIEvent) => any)
    + +
    +
    +

    Fires when the user aborts the download.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onanimationcancel

    +
    onanimationcancel: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationend

    +
    onanimationend: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationiteration

    +
    onanimationiteration: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationstart

    +
    onanimationstart: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onauxclick

    +
    onauxclick: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onblur

    +
    onblur: null | ((ev: FocusEvent) => any)
    + +
    +
    +

    Fires when the object loses the input focus.

    +
    +
    +
    param
    +

    The focus event.

    +
    +
    +
    +
    +
    + +

    oncancel

    +
    oncancel: null | ((ev: Event) => any)
    + +
    +
    + +

    oncanplay

    +
    oncanplay: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback is possible, but would require further buffering.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    oncanplaythrough

    +
    oncanplaythrough: null | ((ev: Event) => any)
    + +
    +
    + +

    onchange

    +
    onchange: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the contents of the object or selection have changed.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onclick

    +
    onclick: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the left mouse button on the object

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onclose

    +
    onclose: null | ((ev: Event) => any)
    + +
    +
    + +

    oncontextmenu

    +
    oncontextmenu: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the right mouse button in the client area, opening the context menu.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    oncopy

    +
    oncopy: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    oncuechange

    +
    oncuechange: null | ((ev: Event) => any)
    + +
    +
    + +

    oncut

    +
    oncut: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    ondblclick

    +
    ondblclick: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user double-clicks the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    ondrag

    +
    ondrag: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object continuously during a drag operation.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragend

    +
    ondragend: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object when the user releases the mouse at the close of a drag operation.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragenter

    +
    ondragenter: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target element when the user drags the object to a valid drop target.

    +
    +
    +
    param
    +

    The drag event.

    +
    +
    +
    +
    +
    + +

    ondragexit

    +
    ondragexit: null | ((ev: Event) => any)
    + +
    +
    + +

    ondragleave

    +
    ondragleave: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

    +
    +
    +
    param
    +

    The drag event.

    +
    +
    +
    +
    +
    + +

    ondragover

    +
    ondragover: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target element continuously while the user drags the object over a valid drop target.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragstart

    +
    ondragstart: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object when the user starts to drag a text selection or selected object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondrop

    +
    ondrop: null | ((ev: DragEvent) => any)
    + +
    +
    + +

    ondurationchange

    +
    ondurationchange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the duration attribute is updated.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onemptied

    +
    onemptied: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the media element is reset to its initial state.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onended

    +
    onended: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the end of playback is reached.

    +
    +
    +
    param
    +

    The event

    +
    +
    +
    +
    +
    + +

    onerror

    +
    onerror: OnErrorEventHandler
    + +
    +
    +

    Fires when an error occurs during object loading.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onfocus

    +
    onfocus: null | ((ev: FocusEvent) => any)
    + +
    +
    +

    Fires when the object receives focus.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onfullscreenchange

    +
    onfullscreenchange: null | ((ev: Event) => any)
    + +
    +
    + +

    onfullscreenerror

    +
    onfullscreenerror: null | ((ev: Event) => any)
    + +
    +
    + +

    ongotpointercapture

    +
    ongotpointercapture: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    oninput

    +
    oninput: null | ((ev: Event) => any)
    + +
    +
    + +

    oninvalid

    +
    oninvalid: null | ((ev: Event) => any)
    + +
    +
    + +

    onkeydown

    +
    onkeydown: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user presses a key.

    +
    +
    +
    param
    +

    The keyboard event

    +
    +
    +
    +
    +
    + +

    onkeypress

    +
    onkeypress: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user presses an alphanumeric key.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onkeyup

    +
    onkeyup: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user releases a key.

    +
    +
    +
    param
    +

    The keyboard event

    +
    +
    +
    +
    +
    + +

    onload

    +
    onload: null | ((ev: Event) => any)
    + +
    +
    +

    Fires immediately after the browser loads the object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadeddata

    +
    onloadeddata: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when media data is loaded at the current playback position.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadedmetadata

    +
    onloadedmetadata: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the duration and dimensions of the media have been determined.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadstart

    +
    onloadstart: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when Internet Explorer begins looking for media data.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onlostpointercapture

    +
    onlostpointercapture: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onmousedown

    +
    onmousedown: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the object with either mouse button.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseenter

    +
    onmouseenter: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onmouseleave

    +
    onmouseleave: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onmousemove

    +
    onmousemove: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse over the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseout

    +
    onmouseout: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse pointer outside the boundaries of the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseover

    +
    onmouseover: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse pointer into the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseup

    +
    onmouseup: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user releases a mouse button while the mouse is over the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onpaste

    +
    onpaste: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    onpause

    +
    onpause: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback is paused.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onplay

    +
    onplay: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the play method is requested.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onplaying

    +
    onplaying: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the audio or video has started playing.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onpointercancel

    +
    onpointercancel: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerdown

    +
    onpointerdown: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerenter

    +
    onpointerenter: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerleave

    +
    onpointerleave: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointermove

    +
    onpointermove: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerout

    +
    onpointerout: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerover

    +
    onpointerover: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerup

    +
    onpointerup: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onprogress

    +
    onprogress: null | ((ev: ProgressEvent<EventTarget>) => any)
    + +
    +
    +

    Occurs to indicate progress while downloading media data.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onratechange

    +
    onratechange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the playback rate is increased or decreased.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onreset

    +
    onreset: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the user resets a form.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onresize

    +
    onresize: null | ((ev: UIEvent) => any)
    + +
    +
    + +

    onscroll

    +
    onscroll: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the user repositions the scroll box in the scroll bar on the object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onsecuritypolicyviolation

    +
    onsecuritypolicyviolation: null | ((ev: SecurityPolicyViolationEvent) => any)
    + +
    +
    + +

    onseeked

    +
    onseeked: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the seek operation ends.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onseeking

    +
    onseeking: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the current playback position is moved.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onselect

    +
    onselect: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the current selection changes.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onselectionchange

    +
    onselectionchange: null | ((ev: Event) => any)
    + +
    +
    + +

    onselectstart

    +
    onselectstart: null | ((ev: Event) => any)
    + +
    +
    + +

    onstalled

    +
    onstalled: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the download has stopped.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onsubmit

    +
    onsubmit: null | ((ev: Event) => any)
    + +
    +
    + +

    onsuspend

    +
    onsuspend: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs if the load operation has been intentionally halted.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ontimeupdate

    +
    ontimeupdate: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs to indicate the current playback position.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ontoggle

    +
    ontoggle: null | ((ev: Event) => any)
    + +
    +
    + +

    Optional ontouchcancel

    +
    ontouchcancel: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchend

    +
    ontouchend: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchmove

    +
    ontouchmove: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchstart

    +
    ontouchstart: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    ontransitioncancel

    +
    ontransitioncancel: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionend

    +
    ontransitionend: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionrun

    +
    ontransitionrun: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionstart

    +
    ontransitionstart: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    onvolumechange

    +
    onvolumechange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the volume is changed, or playback is muted or unmuted.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onwaiting

    +
    onwaiting: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback stops because the next frame of a video resource is not available.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onwheel

    +
    onwheel: null | ((ev: WheelEvent) => any)
    + +
    +
    + +

    outerHTML

    +
    outerHTML: string
    + +
    +
    + +

    Readonly ownerDocument

    +
    ownerDocument: Document
    + +
    +
    + +

    Readonly parentElement

    +
    parentElement: null | HTMLElement
    + +
    +
    +

    Returns the parent element.

    +
    +
    +
    +
    + +

    Readonly parentNode

    +
    parentNode: null | (Node & ParentNode)
    + +
    +
    +

    Returns the parent.

    +
    +
    +
    +
    + +

    Readonly prefix

    +
    prefix: null | string
    + +
    +
    +

    Returns the namespace prefix.

    +
    +
    +
    +
    + +

    Readonly previousElementSibling

    +
    previousElementSibling: null | Element
    + +
    +
    +

    Returns the first preceding sibling that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly previousSibling

    +
    previousSibling: null | ChildNode
    + +
    +
    +

    Returns the previous sibling.

    +
    +
    +
    +
    + +

    Readonly scrollHeight

    +
    scrollHeight: number
    + +
    +
    + +

    scrollLeft

    +
    scrollLeft: number
    + +
    +
    + +

    scrollTop

    +
    scrollTop: number
    + +
    +
    + +

    Readonly scrollWidth

    +
    scrollWidth: number
    + +
    +
    + +

    Readonly shadowRoot

    +
    shadowRoot: null | ShadowRoot
    + +
    +
    +

    Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

    +
    +
    +
    +
    + +

    slot

    +
    slot: string
    + +
    +
    +

    Returns the value of element's slot content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    spellcheck

    +
    spellcheck: boolean
    + +
    +
    + +

    Readonly style

    +
    style: CSSStyleDeclaration
    + +
    +
    + +

    tabIndex

    +
    tabIndex: number
    + +
    +
    + +

    Readonly tagName

    +
    tagName: string
    + +
    +
    +

    Returns the HTML-uppercased qualified name.

    +
    +
    +
    +
    + +

    textContent

    +
    textContent: null | string
    + +
    +
    + +

    title

    +
    title: string
    + +
    +
    + +

    translate

    +
    translate: boolean
    + +
    +
    + +

    Optional webkitRequestFullScreen

    +
    webkitRequestFullScreen: undefined | (() => void)
    + +
    +
    +
    +

    Accessors

    +
    + +

    fullscreenEnabled

    +
      +
    • get fullscreenEnabled(): boolean
      • +
    + +
    +
    + +

    isFullscreen

    +
      +
    • get isFullscreen(): boolean
      • +
    + +
    +
    + +

    traceObserver

    +
      +
    • set traceObserver(observer: null | ((message: string) => void)): void
      • +
    +
      +
    • + +
      +
      +

      Sets a trace observer on this flash player.

      +
      +

      The observer will be called, as a function, for each message that the playing movie will "trace" (output).

      +
      +

      Parameters

      +
        +
      • +
        observer: null | ((message: string) => void)
        +
        +
        +

        The observer that will be called for each trace.

        +
        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    addEventListener

    +
      +
    • addEventListener<K>(type: K, listener: (ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
      • +
    • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

        +
        • +
      +

      Parameters

      +
        +
      • +
        type: K
        +
        • +
      • +
        listener: (ev: HTMLElementEventMap[K]) => any
        +
          +
        • +
            +
          • (ev: HTMLElementEventMap[K]): any
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              ev: HTMLElementEventMap[K]
              +
              • +
            +

            Returns any

            +
            • +
          +
          • +
        +
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      • +
        listener: EventListenerOrEventListenerObject
        +
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    after

    +
      +
    • after(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    animate

    +
      +
    • animate(keyframes: null | Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        keyframes: null | Keyframe[] | PropertyIndexedKeyframes
        +
        • +
      • +
        Optional options: number | KeyframeAnimationOptions
        +
        • +
      +

      Returns Animation

      +
      • +
    +
    +
    + +

    append

    +
      +
    • append(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    appendChild

    +
      +
    • appendChild<T>(newChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    attachShadow

    +
      +
    • attachShadow(init: ShadowRootInit): ShadowRoot
      • +
    +
      +
    • + +
      +
      +

      Creates a shadow root for element and returns it.

      +
      +
      +

      Parameters

      +
        +
      • +
        init: ShadowRootInit
        +
        • +
      +

      Returns ShadowRoot

      +
      • +
    +
    +
    + +

    before

    +
      +
    • before(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    blur

    +
      +
    • blur(): void
      • +
    +
      +
    • + +

      Returns void

      +
      • +
    +
    +
    + +

    click

    +
      +
    • click(): void
      • +
    +
      +
    • + +

      Returns void

      +
      • +
    +
    +
    + +

    cloneNode

    +
      +
    • cloneNode(deep?: boolean): Node
      • +
    +
      +
    • + +
      +
      +

      Returns a copy of node. If deep is true, the copy also includes the node's descendants.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional deep: boolean
        +
        • +
      +

      Returns Node

      +
      • +
    +
    +
    + +

    closest

    +
      +
    • closest<K>(selector: K): null | HTMLElementTagNameMap[K]
      • +
    • closest<K>(selector: K): null | SVGElementTagNameMap[K]
      • +
    • closest<E>(selector: string): null | E
      • +
    +
      +
    • + +
      +
      +

      Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: K
        +
        • +
      +

      Returns null | HTMLElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: K
        +
        • +
      +

      Returns null | SVGElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: string
        +
        • +
      +

      Returns null | E

      +
      • +
    +
    +
    + +

    compareDocumentPosition

    +
      +
    • compareDocumentPosition(other: Node): number
      • +
    +
      +
    • + +
      +
      +

      Returns a bitmask indicating the position of other relative to node.

      +
      +
      +

      Parameters

      +
        +
      • +
        other: Node
        +
        • +
      +

      Returns number

      +
      • +
    +
    +
    + +

    contains

    +
      +
    • contains(other: null | Node): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if other is an inclusive descendant of node, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        other: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    dispatchEvent

    +
      +
    • dispatchEvent(event: Event): boolean
      • +
    +
      +
    • + +
      +
      +

      Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        event: Event
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    displayMessage

    +
      +
    • displayMessage(message: string): void
      • +
    + +
    +
    + +

    enterFullscreen

    +
      +
    • enterFullscreen(): void
      • +
    + +
    +
    + +

    exitFullscreen

    +
      +
    • exitFullscreen(): void
      • +
    + +
    +
    + +

    focus

    +
      +
    • focus(options?: FocusOptions): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: FocusOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    getAnimations

    +
      +
    • getAnimations(): Animation[]
      • +
    +
      +
    • + +

      Returns Animation[]

      +
      • +
    +
    +
    + +

    getAttribute

    +
      +
    • getAttribute(qualifiedName: string): null | string
      • +
    +
      +
    • + +
      +
      +

      Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    getAttributeNS

    +
      +
    • getAttributeNS(namespace: null | string, localName: string): null | string
      • +
    +
      +
    • + +
      +
      +

      Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    getAttributeNames

    +
      +
    • getAttributeNames(): string[]
      • +
    +
      +
    • + +
      +
      +

      Returns the qualified names of all element's attributes. Can contain duplicates.

      +
      +
      +

      Returns string[]

      +
      • +
    +
    +
    + +

    getAttributeNode

    +
      +
    • getAttributeNode(qualifiedName: string): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    getAttributeNodeNS

    +
      +
    • getAttributeNodeNS(namespace: null | string, localName: string): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    getBoundingClientRect

    +
      +
    • getBoundingClientRect(): DOMRect
      • +
    + +
    +
    + +

    getClientRects

    +
      +
    • getClientRects(): DOMRectList
      • +
    +
      +
    • + +

      Returns DOMRectList

      +
      • +
    +
    +
    + +

    getElementsByClassName

    +
      +
    • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +
      +
      +

      Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

      +
      +
      +

      Parameters

      +
        +
      • +
        classNames: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getElementsByTagName

    +
      +
    • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
      • +
    • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
      • +
    • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        qualifiedName: K
        +
        • +
      +

      Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        qualifiedName: K
        +
        • +
      +

      Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getElementsByTagNameNS

    +
      +
    • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
      • +
    • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
      • +
    • getElementsByTagNameNS(namespaceURI: string, localName: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: "http://www.w3.org/1999/xhtml"
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<HTMLElement>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: "http://www.w3.org/2000/svg"
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<SVGElement>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getRootNode

    +
      +
    • getRootNode(options?: GetRootNodeOptions): Node
      • +
    +
      +
    • + +
      +
      +

      Returns node's root.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional options: GetRootNodeOptions
        +
        • +
      +

      Returns Node

      +
      • +
    +
    +
    + +

    hasAttribute

    +
      +
    • hasAttribute(qualifiedName: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasAttributeNS

    +
      +
    • hasAttributeNS(namespace: null | string, localName: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has an attribute whose namespace is namespace and local name is localName.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasAttributes

    +
      +
    • hasAttributes(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has attributes, and false otherwise.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasChildNodes

    +
      +
    • hasChildNodes(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns whether node has children.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasPointerCapture

    +
      +
    • hasPointerCapture(pointerId: number): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    insertAdjacentElement

    +
      +
    • insertAdjacentElement(position: InsertPosition, insertedElement: Element): null | Element
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        position: InsertPosition
        +
        • +
      • +
        insertedElement: Element
        +
        • +
      +

      Returns null | Element

      +
      • +
    +
    +
    + +

    insertAdjacentHTML

    +
      +
    • insertAdjacentHTML(where: InsertPosition, html: string): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        where: InsertPosition
        +
        • +
      • +
        html: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    insertAdjacentText

    +
      +
    • insertAdjacentText(where: InsertPosition, text: string): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        where: InsertPosition
        +
        • +
      • +
        text: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    insertBefore

    +
      +
    • insertBefore<T>(newChild: T, refChild: null | Node): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: T
        +
        • +
      • +
        refChild: null | Node
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    isDefaultNamespace

    +
      +
    • isDefaultNamespace(namespace: null | string): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isEqualNode

    +
      +
    • isEqualNode(otherNode: null | Node): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns whether node and otherNode have the same properties.

      +
      +
      +

      Parameters

      +
        +
      • +
        otherNode: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSameNode

    +
      +
    • isSameNode(otherNode: null | Node): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        otherNode: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    load

    + +
      +
    • + +
      +
      +

      Loads a specified movie into this player.

      +
      +

      This will replace any existing movie that may be playing.

      +
      +

      Parameters

      +
        +
      • +
        options: string | URLLoadOptions | DataLoadOptions
        +
        +

        One of the following:

        +
          +
        • A URL, passed as a string, which will load a URL with default options.
          • +
        • A URLLoadOptions object, to load a URL with options.
          • +
        • A DataLoadOptions object, to load data with options.
          • +
        +

        The options will be defaulted by the config field, which itself + is defaulted by a global window.RufflePlayer.config.

        +
        +
        • +
      +

      Returns Promise<void>

      +
      • +
    +
    +
    + +

    lookupNamespaceURI

    +
      +
    • lookupNamespaceURI(prefix: null | string): null | string
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        prefix: null | string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    lookupPrefix

    +
      +
    • lookupPrefix(namespace: null | string): null | string
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    matches

    +
      +
    • matches(selectors: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if matching selectors against element's root yields element, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    msGetRegionContent

    +
      +
    • msGetRegionContent(): any
      • +
    + +
    +
    + +

    normalize

    +
      +
    • normalize(): void
      • +
    +
      +
    • + +
      +
      +

      Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

      +
      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    panic

    +
      +
    • panic(error: null | Error): void
      • +
    +
      +
    • + +
      +
      +

      Panics this specific player, forcefully destroying all resources and displays an error message to the user.

      +
      +

      This should be called when something went absolutely, incredibly and disastrously wrong and there is no chance + of recovery.

      +

      Ruffle will attempt to isolate all damage to this specific player instance, but no guarantees can be made if there + was a core issue which triggered the panic. If Ruffle is unable to isolate the cause to a specific player, then + all players will panic and Ruffle will become "poisoned" - no more players will run on this page until it is + reloaded fresh.

      +
      +

      Parameters

      +
        +
      • +
        error: null | Error
        +
        +

        The error, if any, that triggered this panic.

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    pause

    +
      +
    • pause(): void
      • +
    +
      +
    • + +
      +
      +

      Pauses this player.

      +
      +

      No more frames, scripts or sounds will be executed. + This movie will be considered inactive and will not wake up until resumed.

      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    play

    +
      +
    • play(): void
      • +
    + +
    +
    + +

    prepend

    +
      +
    • prepend(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    querySelector

    +
      +
    • querySelector<K>(selectors: K): null | HTMLElementTagNameMap[K]
      • +
    • querySelector<K>(selectors: K): null | SVGElementTagNameMap[K]
      • +
    • querySelector<E>(selectors: string): null | E
      • +
    +
      +
    • + +
      +
      +

      Returns the first element that is a descendant of node that matches selectors.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns null | HTMLElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns null | SVGElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns null | E

      +
      • +
    +
    +
    + +

    querySelectorAll

    +
      +
    • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
      • +
    • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
      • +
    • querySelectorAll<E>(selectors: string): NodeListOf<E>
      • +
    +
      +
    • + +
      +
      +

      Returns all element descendants of node that match selectors.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns NodeListOf<HTMLElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns NodeListOf<SVGElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns NodeListOf<E>

      +
      • +
    +
    +
    + +

    releasePointerCapture

    +
      +
    • releasePointerCapture(pointerId: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    remove

    +
      +
    • remove(): void
      • +
    +
      +
    • + +
      +
      +

      Removes node.

      +
      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttribute

    +
      +
    • removeAttribute(qualifiedName: string): void
      • +
    +
      +
    • + +
      +
      +

      Removes element's first attribute whose qualified name is qualifiedName.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttributeNS

    +
      +
    • removeAttributeNS(namespace: null | string, localName: string): void
      • +
    +
      +
    • + +
      +
      +

      Removes element's attribute whose namespace is namespace and local name is localName.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttributeNode

    +
      +
    • removeAttributeNode(attr: Attr): Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns Attr

      +
      • +
    +
    +
    + +

    removeChild

    +
      +
    • removeChild<T>(oldChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        oldChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    removeEventListener

    +
      +
    • removeEventListener<K>(type: K, listener: (ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void
      • +
    • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

        +
        • +
      +

      Parameters

      +
        +
      • +
        type: K
        +
        • +
      • +
        listener: (ev: HTMLElementEventMap[K]) => any
        +
          +
        • +
            +
          • (ev: HTMLElementEventMap[K]): any
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              ev: HTMLElementEventMap[K]
              +
              • +
            +

            Returns any

            +
            • +
          +
          • +
        +
        • +
      • +
        Optional options: boolean | EventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      • +
        listener: EventListenerOrEventListenerObject
        +
        • +
      • +
        Optional options: boolean | EventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    replaceChild

    +
      +
    • replaceChild<T>(newChild: Node, oldChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: Node
        +
        • +
      • +
        oldChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    replaceWith

    +
      +
    • replaceWith(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    requestFullscreen

    +
      +
    • requestFullscreen(options?: FullscreenOptions): Promise<void>
      • +
    +
      +
    • + +
      +
      +

      Displays element fullscreen and resolves promise when done.

      +
      +

      When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

      +
      +

      Parameters

      +
        +
      • +
        Optional options: FullscreenOptions
        +
        • +
      +

      Returns Promise<void>

      +
      • +
    +
    +
    + +

    requestPointerLock

    +
      +
    • requestPointerLock(): void
      • +
    + +
    +
    + +

    scroll

    +
      +
    • scroll(options?: ScrollToOptions): void
      • +
    • scroll(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollBy

    +
      +
    • scrollBy(options?: ScrollToOptions): void
      • +
    • scrollBy(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollIntoView

    +
      +
    • scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional arg: boolean | ScrollIntoViewOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollTo

    +
      +
    • scrollTo(options?: ScrollToOptions): void
      • +
    • scrollTo(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttribute

    +
      +
    • setAttribute(qualifiedName: string, value: string): void
      • +
    +
      +
    • + +
      +
      +

      Sets the value of element's first attribute whose qualified name is qualifiedName to value.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      • +
        value: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttributeNS

    +
      +
    • setAttributeNS(namespace: null | string, qualifiedName: string, value: string): void
      • +
    +
      +
    • + +
      +
      +

      Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        qualifiedName: string
        +
        • +
      • +
        value: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttributeNode

    +
      +
    • setAttributeNode(attr: Attr): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    setAttributeNodeNS

    +
      +
    • setAttributeNodeNS(attr: Attr): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    setPointerCapture

    +
      +
    • setPointerCapture(pointerId: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    toggleAttribute

    +
      +
    • toggleAttribute(qualifiedName: string, force?: boolean): boolean
      • +
    +
      +
    • + +
      +
      +

      If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

      +
      +

      Returns true if qualifiedName is now present, and false otherwise.

      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      • +
        Optional force: boolean
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    webkitMatchesSelector

    +
      +
    • webkitMatchesSelector(selectors: string): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    Static fromNativeObjectElement

    +
      +
    • fromNativeObjectElement(elem: HTMLElement): RuffleObject
      • +
    +
      +
    • + +
      +
      +

      Creates a RuffleObject that will polyfill and replace the given element.

      +
      +
      +

      Parameters

      +
        +
      • +
        elem: HTMLElement
        +
        +

        Element to replace.

        +
        +
        • +
      +

      Returns RuffleObject

      +

      Created RuffleObject.

      +
      • +
    +
    +
    + +

    Static isInterdictable

    +
      +
    • isInterdictable(elem: HTMLElement): boolean
      • +
    +
      +
    • + +
      +
      +

      Checks if the given element may be polyfilled with this one.

      +
      +
      +

      Parameters

      +
        +
      • +
        elem: HTMLElement
        +
        +

        Element to check.

        +
        +
        • +
      +

      Returns boolean

      +

      True if the element looks like a flash object.

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    +
      +
    • Property
      • +
    +
      +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + \ No newline at end of file diff --git a/master/classes/ruffleplayer.html b/master/classes/ruffleplayer.html new file mode 100644 index 000000000..5184637a7 --- /dev/null +++ b/master/classes/ruffleplayer.html @@ -0,0 +1,6146 @@ + + + + + + RufflePlayer | ruffle-core + + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class RufflePlayer

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    The ruffle player element that should be inserted onto the page.

    +
    +

    This element will represent the rendered and intractable flash movie.

    +
    +
    +
    +

    Hierarchy

    + +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Properties

    + +
    +
    +

    Accessors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Properties

    +
    + +

    Readonly ATTRIBUTE_NODE

    +
    ATTRIBUTE_NODE: number
    + +
    +
    + +

    Readonly CDATA_SECTION_NODE

    +
    CDATA_SECTION_NODE: number
    + +
    +
    +

    node is a CDATASection node.

    +
    +
    +
    +
    + +

    Readonly COMMENT_NODE

    +
    COMMENT_NODE: number
    + +
    +
    +

    node is a Comment node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_FRAGMENT_NODE

    +
    DOCUMENT_FRAGMENT_NODE: number
    + +
    +
    +

    node is a DocumentFragment node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_NODE

    +
    DOCUMENT_NODE: number
    + +
    +
    +

    node is a document.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_CONTAINED_BY

    +
    DOCUMENT_POSITION_CONTAINED_BY: number
    + +
    +
    +

    Set when other is a descendant of node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_CONTAINS

    +
    DOCUMENT_POSITION_CONTAINS: number
    + +
    +
    +

    Set when other is an ancestor of node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_DISCONNECTED

    +
    DOCUMENT_POSITION_DISCONNECTED: number
    + +
    +
    +

    Set when node and other are not in the same tree.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_FOLLOWING

    +
    DOCUMENT_POSITION_FOLLOWING: number
    + +
    +
    +

    Set when other is following node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

    +
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number
    + +
    +
    + +

    Readonly DOCUMENT_POSITION_PRECEDING

    +
    DOCUMENT_POSITION_PRECEDING: number
    + +
    +
    +

    Set when other is preceding node.

    +
    +
    +
    +
    + +

    Readonly DOCUMENT_TYPE_NODE

    +
    DOCUMENT_TYPE_NODE: number
    + +
    +
    +

    node is a doctype.

    +
    +
    +
    +
    + +

    Readonly ELEMENT_NODE

    +
    ELEMENT_NODE: number
    + +
    +
    +

    node is an element.

    +
    +
    +
    +
    + +

    Readonly ENTITY_NODE

    +
    ENTITY_NODE: number
    + +
    +
    + +

    Readonly ENTITY_REFERENCE_NODE

    +
    ENTITY_REFERENCE_NODE: number
    + +
    +
    + +

    Readonly NOTATION_NODE

    +
    NOTATION_NODE: number
    + +
    +
    + +

    Readonly PROCESSING_INSTRUCTION_NODE

    +
    PROCESSING_INSTRUCTION_NODE: number
    + +
    +
    +

    node is a ProcessingInstruction node.

    +
    +
    +
    +
    + +

    Readonly TEXT_NODE

    +
    TEXT_NODE: number
    + +
    +
    +

    node is a Text node.

    +
    +
    +
    +
    + +

    accessKey

    +
    accessKey: string
    + +
    +
    + +

    Readonly accessKeyLabel

    +
    accessKeyLabel: string
    + +
    +
    + +

    allowScriptAccess

    +
    allowScriptAccess: boolean
    + +
    +
    +

    If set to true, the movie is allowed to interact with the page through + JavaScript, using a flash concept called ExternalInterface.

    +
    +

    This should only be enabled for movies you trust.

    +
    +
    +
    + +

    Readonly assignedSlot

    +
    assignedSlot: null | HTMLSlotElement
    + +
    +
    + +

    Readonly attributes

    +
    attributes: NamedNodeMap
    + +
    +
    + +

    autocapitalize

    +
    autocapitalize: string
    + +
    +
    + +

    autofocus

    +
    autofocus: boolean
    + +
    +
    + +

    Readonly baseURI

    +
    baseURI: string
    + +
    +
    +

    Returns node's node document's document base URL.

    +
    +
    +
    +
    + +

    Readonly childElementCount

    +
    childElementCount: number
    + +
    +
    + +

    Readonly childNodes

    +
    childNodes: NodeListOf<ChildNode>
    + +
    +
    +

    Returns the children.

    +
    +
    +
    +
    + +

    Readonly children

    +
    children: HTMLCollection
    + +
    +
    +

    Returns the child elements.

    +
    +
    +
    +
    + +

    Readonly classList

    +
    classList: DOMTokenList
    + +
    +
    +

    Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

    +
    +
    +
    +
    + +

    className

    +
    className: string
    + +
    +
    +

    Returns the value of element's class content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    Readonly clientHeight

    +
    clientHeight: number
    + +
    +
    + +

    Readonly clientLeft

    +
    clientLeft: number
    + +
    +
    + +

    Readonly clientTop

    +
    clientTop: number
    + +
    +
    + +

    Readonly clientWidth

    +
    clientWidth: number
    + +
    +
    + +

    config

    +
    config: Config = ...
    + +
    +
    +

    Any configuration that should apply to this specific player. + This will be defaulted with any global configuration.

    +
    +
    +
    +
    + +

    contentEditable

    +
    contentEditable: string
    + +
    +
    + +

    Readonly dataset

    +
    dataset: DOMStringMap
    + +
    +
    + +

    dir

    +
    dir: string
    + +
    +
    + +

    draggable

    +
    draggable: boolean
    + +
    +
    + +

    enterKeyHint

    +
    enterKeyHint: string
    + +
    +
    + +

    Readonly firstChild

    +
    firstChild: null | ChildNode
    + +
    +
    +

    Returns the first child.

    +
    +
    +
    +
    + +

    Readonly firstElementChild

    +
    firstElementChild: null | Element
    + +
    +
    +

    Returns the first child that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    hidden

    +
    hidden: boolean
    + +
    +
    + +

    id

    +
    id: string
    + +
    +
    +

    Returns the value of element's id content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    innerHTML

    +
    innerHTML: string
    + +
    +
    + +

    innerText

    +
    innerText: string
    + +
    +
    + +

    inputMode

    +
    inputMode: string
    + +
    +
    + +

    Readonly isConnected

    +
    isConnected: boolean
    + +
    +
    +

    Returns true if node is connected and false otherwise.

    +
    +
    +
    +
    + +

    Readonly isContentEditable

    +
    isContentEditable: boolean
    + +
    +
    + +

    lang

    +
    lang: string
    + +
    +
    + +

    Readonly lastChild

    +
    lastChild: null | ChildNode
    + +
    +
    +

    Returns the last child.

    +
    +
    +
    +
    + +

    Readonly lastElementChild

    +
    lastElementChild: null | Element
    + +
    +
    +

    Returns the last child that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly localName

    +
    localName: string
    + +
    +
    +

    Returns the local name.

    +
    +
    +
    +
    + +

    Readonly namespaceURI

    +
    namespaceURI: null | string
    + +
    +
    +

    Returns the namespace.

    +
    +
    +
    +
    + +

    Readonly nextElementSibling

    +
    nextElementSibling: null | Element
    + +
    +
    +

    Returns the first following sibling that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly nextSibling

    +
    nextSibling: null | ChildNode
    + +
    +
    +

    Returns the next sibling.

    +
    +
    +
    +
    + +

    Readonly nodeName

    +
    nodeName: string
    + +
    +
    +

    Returns a string appropriate for the type of node.

    +
    +
    +
    +
    + +

    Readonly nodeType

    +
    nodeType: number
    + +
    +
    +

    Returns the type of node.

    +
    +
    +
    +
    + +

    nodeValue

    +
    nodeValue: null | string
    + +
    +
    + +

    Optional nonce

    +
    nonce: undefined | string
    + +
    +
    + +

    Readonly offsetHeight

    +
    offsetHeight: number
    + +
    +
    + +

    Readonly offsetLeft

    +
    offsetLeft: number
    + +
    +
    + +

    Readonly offsetParent

    +
    offsetParent: null | Element
    + +
    +
    + +

    Readonly offsetTop

    +
    offsetTop: number
    + +
    +
    + +

    Readonly offsetWidth

    +
    offsetWidth: number
    + +
    +
    + +

    onabort

    +
    onabort: null | ((ev: UIEvent) => any)
    + +
    +
    +

    Fires when the user aborts the download.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onanimationcancel

    +
    onanimationcancel: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationend

    +
    onanimationend: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationiteration

    +
    onanimationiteration: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onanimationstart

    +
    onanimationstart: null | ((ev: AnimationEvent) => any)
    + +
    +
    + +

    onauxclick

    +
    onauxclick: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onblur

    +
    onblur: null | ((ev: FocusEvent) => any)
    + +
    +
    +

    Fires when the object loses the input focus.

    +
    +
    +
    param
    +

    The focus event.

    +
    +
    +
    +
    +
    + +

    oncancel

    +
    oncancel: null | ((ev: Event) => any)
    + +
    +
    + +

    oncanplay

    +
    oncanplay: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback is possible, but would require further buffering.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    oncanplaythrough

    +
    oncanplaythrough: null | ((ev: Event) => any)
    + +
    +
    + +

    onchange

    +
    onchange: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the contents of the object or selection have changed.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onclick

    +
    onclick: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the left mouse button on the object

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onclose

    +
    onclose: null | ((ev: Event) => any)
    + +
    +
    + +

    oncontextmenu

    +
    oncontextmenu: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the right mouse button in the client area, opening the context menu.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    oncopy

    +
    oncopy: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    oncuechange

    +
    oncuechange: null | ((ev: Event) => any)
    + +
    +
    + +

    oncut

    +
    oncut: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    ondblclick

    +
    ondblclick: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user double-clicks the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    ondrag

    +
    ondrag: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object continuously during a drag operation.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragend

    +
    ondragend: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object when the user releases the mouse at the close of a drag operation.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragenter

    +
    ondragenter: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target element when the user drags the object to a valid drop target.

    +
    +
    +
    param
    +

    The drag event.

    +
    +
    +
    +
    +
    + +

    ondragexit

    +
    ondragexit: null | ((ev: Event) => any)
    + +
    +
    + +

    ondragleave

    +
    ondragleave: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

    +
    +
    +
    param
    +

    The drag event.

    +
    +
    +
    +
    +
    + +

    ondragover

    +
    ondragover: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the target element continuously while the user drags the object over a valid drop target.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondragstart

    +
    ondragstart: null | ((ev: DragEvent) => any)
    + +
    +
    +

    Fires on the source object when the user starts to drag a text selection or selected object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ondrop

    +
    ondrop: null | ((ev: DragEvent) => any)
    + +
    +
    + +

    ondurationchange

    +
    ondurationchange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the duration attribute is updated.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onemptied

    +
    onemptied: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the media element is reset to its initial state.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onended

    +
    onended: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the end of playback is reached.

    +
    +
    +
    param
    +

    The event

    +
    +
    +
    +
    +
    + +

    onerror

    +
    onerror: OnErrorEventHandler
    + +
    +
    +

    Fires when an error occurs during object loading.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onfocus

    +
    onfocus: null | ((ev: FocusEvent) => any)
    + +
    +
    +

    Fires when the object receives focus.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onfullscreenchange

    +
    onfullscreenchange: null | ((ev: Event) => any)
    + +
    +
    + +

    onfullscreenerror

    +
    onfullscreenerror: null | ((ev: Event) => any)
    + +
    +
    + +

    ongotpointercapture

    +
    ongotpointercapture: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    oninput

    +
    oninput: null | ((ev: Event) => any)
    + +
    +
    + +

    oninvalid

    +
    oninvalid: null | ((ev: Event) => any)
    + +
    +
    + +

    onkeydown

    +
    onkeydown: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user presses a key.

    +
    +
    +
    param
    +

    The keyboard event

    +
    +
    +
    +
    +
    + +

    onkeypress

    +
    onkeypress: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user presses an alphanumeric key.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onkeyup

    +
    onkeyup: null | ((ev: KeyboardEvent) => any)
    + +
    +
    +

    Fires when the user releases a key.

    +
    +
    +
    param
    +

    The keyboard event

    +
    +
    +
    +
    +
    + +

    onload

    +
    onload: null | ((ev: Event) => any)
    + +
    +
    +

    Fires immediately after the browser loads the object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadeddata

    +
    onloadeddata: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when media data is loaded at the current playback position.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadedmetadata

    +
    onloadedmetadata: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the duration and dimensions of the media have been determined.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onloadstart

    +
    onloadstart: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when Internet Explorer begins looking for media data.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onlostpointercapture

    +
    onlostpointercapture: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onmousedown

    +
    onmousedown: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user clicks the object with either mouse button.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseenter

    +
    onmouseenter: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onmouseleave

    +
    onmouseleave: null | ((ev: MouseEvent) => any)
    + +
    +
    + +

    onmousemove

    +
    onmousemove: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse over the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseout

    +
    onmouseout: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse pointer outside the boundaries of the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseover

    +
    onmouseover: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user moves the mouse pointer into the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onmouseup

    +
    onmouseup: null | ((ev: MouseEvent) => any)
    + +
    +
    +

    Fires when the user releases a mouse button while the mouse is over the object.

    +
    +
    +
    param
    +

    The mouse event.

    +
    +
    +
    +
    +
    + +

    onpaste

    +
    onpaste: null | ((ev: ClipboardEvent) => any)
    + +
    +
    + +

    onpause

    +
    onpause: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback is paused.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onplay

    +
    onplay: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the play method is requested.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onplaying

    +
    onplaying: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the audio or video has started playing.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onpointercancel

    +
    onpointercancel: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerdown

    +
    onpointerdown: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerenter

    +
    onpointerenter: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerleave

    +
    onpointerleave: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointermove

    +
    onpointermove: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerout

    +
    onpointerout: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerover

    +
    onpointerover: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onpointerup

    +
    onpointerup: null | ((ev: PointerEvent) => any)
    + +
    +
    + +

    onprogress

    +
    onprogress: null | ((ev: ProgressEvent<EventTarget>) => any)
    + +
    +
    +

    Occurs to indicate progress while downloading media data.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onratechange

    +
    onratechange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the playback rate is increased or decreased.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onreset

    +
    onreset: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the user resets a form.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onresize

    +
    onresize: null | ((ev: UIEvent) => any)
    + +
    +
    + +

    onscroll

    +
    onscroll: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the user repositions the scroll box in the scroll bar on the object.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onsecuritypolicyviolation

    +
    onsecuritypolicyviolation: null | ((ev: SecurityPolicyViolationEvent) => any)
    + +
    +
    + +

    onseeked

    +
    onseeked: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the seek operation ends.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onseeking

    +
    onseeking: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the current playback position is moved.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onselect

    +
    onselect: null | ((ev: Event) => any)
    + +
    +
    +

    Fires when the current selection changes.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onselectionchange

    +
    onselectionchange: null | ((ev: Event) => any)
    + +
    +
    + +

    onselectstart

    +
    onselectstart: null | ((ev: Event) => any)
    + +
    +
    + +

    onstalled

    +
    onstalled: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the download has stopped.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onsubmit

    +
    onsubmit: null | ((ev: Event) => any)
    + +
    +
    + +

    onsuspend

    +
    onsuspend: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs if the load operation has been intentionally halted.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ontimeupdate

    +
    ontimeupdate: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs to indicate the current playback position.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    ontoggle

    +
    ontoggle: null | ((ev: Event) => any)
    + +
    +
    + +

    Optional ontouchcancel

    +
    ontouchcancel: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchend

    +
    ontouchend: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchmove

    +
    ontouchmove: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    Optional ontouchstart

    +
    ontouchstart: undefined | null | ((ev: TouchEvent) => any)
    + +
    +
    + +

    ontransitioncancel

    +
    ontransitioncancel: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionend

    +
    ontransitionend: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionrun

    +
    ontransitionrun: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    ontransitionstart

    +
    ontransitionstart: null | ((ev: TransitionEvent) => any)
    + +
    +
    + +

    onvolumechange

    +
    onvolumechange: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when the volume is changed, or playback is muted or unmuted.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onwaiting

    +
    onwaiting: null | ((ev: Event) => any)
    + +
    +
    +

    Occurs when playback stops because the next frame of a video resource is not available.

    +
    +
    +
    param
    +

    The event.

    +
    +
    +
    +
    +
    + +

    onwheel

    +
    onwheel: null | ((ev: WheelEvent) => any)
    + +
    +
    + +

    outerHTML

    +
    outerHTML: string
    + +
    +
    + +

    Readonly ownerDocument

    +
    ownerDocument: Document
    + +
    +
    + +

    Readonly parentElement

    +
    parentElement: null | HTMLElement
    + +
    +
    +

    Returns the parent element.

    +
    +
    +
    +
    + +

    Readonly parentNode

    +
    parentNode: null | (Node & ParentNode)
    + +
    +
    +

    Returns the parent.

    +
    +
    +
    +
    + +

    Readonly prefix

    +
    prefix: null | string
    + +
    +
    +

    Returns the namespace prefix.

    +
    +
    +
    +
    + +

    Readonly previousElementSibling

    +
    previousElementSibling: null | Element
    + +
    +
    +

    Returns the first preceding sibling that is an element, and null otherwise.

    +
    +
    +
    +
    + +

    Readonly previousSibling

    +
    previousSibling: null | ChildNode
    + +
    +
    +

    Returns the previous sibling.

    +
    +
    +
    +
    + +

    Readonly scrollHeight

    +
    scrollHeight: number
    + +
    +
    + +

    scrollLeft

    +
    scrollLeft: number
    + +
    +
    + +

    scrollTop

    +
    scrollTop: number
    + +
    +
    + +

    Readonly scrollWidth

    +
    scrollWidth: number
    + +
    +
    + +

    Readonly shadowRoot

    +
    shadowRoot: null | ShadowRoot
    + +
    +
    +

    Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

    +
    +
    +
    +
    + +

    slot

    +
    slot: string
    + +
    +
    +

    Returns the value of element's slot content attribute. Can be set to change it.

    +
    +
    +
    +
    + +

    spellcheck

    +
    spellcheck: boolean
    + +
    +
    + +

    Readonly style

    +
    style: CSSStyleDeclaration
    + +
    +
    + +

    tabIndex

    +
    tabIndex: number
    + +
    +
    + +

    Readonly tagName

    +
    tagName: string
    + +
    +
    +

    Returns the HTML-uppercased qualified name.

    +
    +
    +
    +
    + +

    textContent

    +
    textContent: null | string
    + +
    +
    + +

    title

    +
    title: string
    + +
    +
    + +

    translate

    +
    translate: boolean
    + +
    +
    + +

    Optional webkitRequestFullScreen

    +
    webkitRequestFullScreen: undefined | (() => void)
    + +
    +
    +
    +

    Accessors

    +
    + +

    fullscreenEnabled

    +
      +
    • get fullscreenEnabled(): boolean
      • +
    + +
    +
    + +

    isFullscreen

    +
      +
    • get isFullscreen(): boolean
      • +
    + +
    +
    + +

    traceObserver

    +
      +
    • set traceObserver(observer: null | ((message: string) => void)): void
      • +
    +
      +
    • + +
      +
      +

      Sets a trace observer on this flash player.

      +
      +

      The observer will be called, as a function, for each message that the playing movie will "trace" (output).

      +
      +

      Parameters

      +
        +
      • +
        observer: null | ((message: string) => void)
        +
        +
        +

        The observer that will be called for each trace.

        +
        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    addEventListener

    +
      +
    • addEventListener<K>(type: K, listener: (ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
      • +
    • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

        +
        • +
      +

      Parameters

      +
        +
      • +
        type: K
        +
        • +
      • +
        listener: (ev: HTMLElementEventMap[K]) => any
        +
          +
        • +
            +
          • (ev: HTMLElementEventMap[K]): any
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              ev: HTMLElementEventMap[K]
              +
              • +
            +

            Returns any

            +
            • +
          +
          • +
        +
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      • +
        listener: EventListenerOrEventListenerObject
        +
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    after

    +
      +
    • after(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    animate

    +
      +
    • animate(keyframes: null | Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        keyframes: null | Keyframe[] | PropertyIndexedKeyframes
        +
        • +
      • +
        Optional options: number | KeyframeAnimationOptions
        +
        • +
      +

      Returns Animation

      +
      • +
    +
    +
    + +

    append

    +
      +
    • append(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    appendChild

    +
      +
    • appendChild<T>(newChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    attachShadow

    +
      +
    • attachShadow(init: ShadowRootInit): ShadowRoot
      • +
    +
      +
    • + +
      +
      +

      Creates a shadow root for element and returns it.

      +
      +
      +

      Parameters

      +
        +
      • +
        init: ShadowRootInit
        +
        • +
      +

      Returns ShadowRoot

      +
      • +
    +
    +
    + +

    before

    +
      +
    • before(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    blur

    +
      +
    • blur(): void
      • +
    +
      +
    • + +

      Returns void

      +
      • +
    +
    +
    + +

    click

    +
      +
    • click(): void
      • +
    +
      +
    • + +

      Returns void

      +
      • +
    +
    +
    + +

    cloneNode

    +
      +
    • cloneNode(deep?: boolean): Node
      • +
    +
      +
    • + +
      +
      +

      Returns a copy of node. If deep is true, the copy also includes the node's descendants.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional deep: boolean
        +
        • +
      +

      Returns Node

      +
      • +
    +
    +
    + +

    closest

    +
      +
    • closest<K>(selector: K): null | HTMLElementTagNameMap[K]
      • +
    • closest<K>(selector: K): null | SVGElementTagNameMap[K]
      • +
    • closest<E>(selector: string): null | E
      • +
    +
      +
    • + +
      +
      +

      Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: K
        +
        • +
      +

      Returns null | HTMLElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: K
        +
        • +
      +

      Returns null | SVGElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selector: string
        +
        • +
      +

      Returns null | E

      +
      • +
    +
    +
    + +

    compareDocumentPosition

    +
      +
    • compareDocumentPosition(other: Node): number
      • +
    +
      +
    • + +
      +
      +

      Returns a bitmask indicating the position of other relative to node.

      +
      +
      +

      Parameters

      +
        +
      • +
        other: Node
        +
        • +
      +

      Returns number

      +
      • +
    +
    +
    + +

    contains

    +
      +
    • contains(other: null | Node): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if other is an inclusive descendant of node, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        other: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    dispatchEvent

    +
      +
    • dispatchEvent(event: Event): boolean
      • +
    +
      +
    • + +
      +
      +

      Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        event: Event
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    displayMessage

    +
      +
    • displayMessage(message: string): void
      • +
    + +
    +
    + +

    enterFullscreen

    +
      +
    • enterFullscreen(): void
      • +
    + +
    +
    + +

    exitFullscreen

    +
      +
    • exitFullscreen(): void
      • +
    + +
    +
    + +

    focus

    +
      +
    • focus(options?: FocusOptions): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: FocusOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    getAnimations

    +
      +
    • getAnimations(): Animation[]
      • +
    +
      +
    • + +

      Returns Animation[]

      +
      • +
    +
    +
    + +

    getAttribute

    +
      +
    • getAttribute(qualifiedName: string): null | string
      • +
    +
      +
    • + +
      +
      +

      Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    getAttributeNS

    +
      +
    • getAttributeNS(namespace: null | string, localName: string): null | string
      • +
    +
      +
    • + +
      +
      +

      Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    getAttributeNames

    +
      +
    • getAttributeNames(): string[]
      • +
    +
      +
    • + +
      +
      +

      Returns the qualified names of all element's attributes. Can contain duplicates.

      +
      +
      +

      Returns string[]

      +
      • +
    +
    +
    + +

    getAttributeNode

    +
      +
    • getAttributeNode(qualifiedName: string): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    getAttributeNodeNS

    +
      +
    • getAttributeNodeNS(namespace: null | string, localName: string): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    getBoundingClientRect

    +
      +
    • getBoundingClientRect(): DOMRect
      • +
    +
      +
    • + +

      Returns DOMRect

      +
      • +
    +
    +
    + +

    getClientRects

    +
      +
    • getClientRects(): DOMRectList
      • +
    +
      +
    • + +

      Returns DOMRectList

      +
      • +
    +
    +
    + +

    getElementsByClassName

    +
      +
    • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +
      +
      +

      Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

      +
      +
      +

      Parameters

      +
        +
      • +
        classNames: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getElementsByTagName

    +
      +
    • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
      • +
    • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
      • +
    • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        qualifiedName: K
        +
        • +
      +

      Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        qualifiedName: K
        +
        • +
      +

      Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getElementsByTagNameNS

    +
      +
    • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
      • +
    • getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
      • +
    • getElementsByTagNameNS(namespaceURI: string, localName: string): HTMLCollectionOf<Element>
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: "http://www.w3.org/1999/xhtml"
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<HTMLElement>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: "http://www.w3.org/2000/svg"
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<SVGElement>

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        namespaceURI: string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns HTMLCollectionOf<Element>

      +
      • +
    +
    +
    + +

    getRootNode

    +
      +
    • getRootNode(options?: GetRootNodeOptions): Node
      • +
    +
      +
    • + +
      +
      +

      Returns node's root.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional options: GetRootNodeOptions
        +
        • +
      +

      Returns Node

      +
      • +
    +
    +
    + +

    hasAttribute

    +
      +
    • hasAttribute(qualifiedName: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasAttributeNS

    +
      +
    • hasAttributeNS(namespace: null | string, localName: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has an attribute whose namespace is namespace and local name is localName.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasAttributes

    +
      +
    • hasAttributes(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if element has attributes, and false otherwise.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasChildNodes

    +
      +
    • hasChildNodes(): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns whether node has children.

      +
      +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    hasPointerCapture

    +
      +
    • hasPointerCapture(pointerId: number): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    insertAdjacentElement

    +
      +
    • insertAdjacentElement(position: InsertPosition, insertedElement: Element): null | Element
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        position: InsertPosition
        +
        • +
      • +
        insertedElement: Element
        +
        • +
      +

      Returns null | Element

      +
      • +
    +
    +
    + +

    insertAdjacentHTML

    +
      +
    • insertAdjacentHTML(where: InsertPosition, html: string): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        where: InsertPosition
        +
        • +
      • +
        html: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    insertAdjacentText

    +
      +
    • insertAdjacentText(where: InsertPosition, text: string): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        where: InsertPosition
        +
        • +
      • +
        text: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    insertBefore

    +
      +
    • insertBefore<T>(newChild: T, refChild: null | Node): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: T
        +
        • +
      • +
        refChild: null | Node
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    isDefaultNamespace

    +
      +
    • isDefaultNamespace(namespace: null | string): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isEqualNode

    +
      +
    • isEqualNode(otherNode: null | Node): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns whether node and otherNode have the same properties.

      +
      +
      +

      Parameters

      +
        +
      • +
        otherNode: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    isSameNode

    +
      +
    • isSameNode(otherNode: null | Node): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        otherNode: null | Node
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    load

    + +
      +
    • + +
      +
      +

      Loads a specified movie into this player.

      +
      +

      This will replace any existing movie that may be playing.

      +
      +

      Parameters

      +
        +
      • +
        options: string | URLLoadOptions | DataLoadOptions
        +
        +

        One of the following:

        +
          +
        • A URL, passed as a string, which will load a URL with default options.
          • +
        • A URLLoadOptions object, to load a URL with options.
          • +
        • A DataLoadOptions object, to load data with options.
          • +
        +

        The options will be defaulted by the config field, which itself + is defaulted by a global window.RufflePlayer.config.

        +
        +
        • +
      +

      Returns Promise<void>

      +
      • +
    +
    +
    + +

    lookupNamespaceURI

    +
      +
    • lookupNamespaceURI(prefix: null | string): null | string
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        prefix: null | string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    lookupPrefix

    +
      +
    • lookupPrefix(namespace: null | string): null | string
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      +

      Returns null | string

      +
      • +
    +
    +
    + +

    matches

    +
      +
    • matches(selectors: string): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if matching selectors against element's root yields element, and false otherwise.

      +
      +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    msGetRegionContent

    +
      +
    • msGetRegionContent(): any
      • +
    +
      +
    • + +

      Returns any

      +
      • +
    +
    +
    + +

    normalize

    +
      +
    • normalize(): void
      • +
    +
      +
    • + +
      +
      +

      Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

      +
      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    panic

    +
      +
    • panic(error: null | Error): void
      • +
    +
      +
    • + +
      +
      +

      Panics this specific player, forcefully destroying all resources and displays an error message to the user.

      +
      +

      This should be called when something went absolutely, incredibly and disastrously wrong and there is no chance + of recovery.

      +

      Ruffle will attempt to isolate all damage to this specific player instance, but no guarantees can be made if there + was a core issue which triggered the panic. If Ruffle is unable to isolate the cause to a specific player, then + all players will panic and Ruffle will become "poisoned" - no more players will run on this page until it is + reloaded fresh.

      +
      +

      Parameters

      +
        +
      • +
        error: null | Error
        +
        +

        The error, if any, that triggered this panic.

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    pause

    +
      +
    • pause(): void
      • +
    +
      +
    • + +
      +
      +

      Pauses this player.

      +
      +

      No more frames, scripts or sounds will be executed. + This movie will be considered inactive and will not wake up until resumed.

      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    play

    +
      +
    • play(): void
      • +
    + +
    +
    + +

    prepend

    +
      +
    • prepend(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    querySelector

    +
      +
    • querySelector<K>(selectors: K): null | HTMLElementTagNameMap[K]
      • +
    • querySelector<K>(selectors: K): null | SVGElementTagNameMap[K]
      • +
    • querySelector<E>(selectors: string): null | E
      • +
    +
      +
    • + +
      +
      +

      Returns the first element that is a descendant of node that matches selectors.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns null | HTMLElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns null | SVGElementTagNameMap[K]

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns null | E

      +
      • +
    +
    +
    + +

    querySelectorAll

    +
      +
    • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
      • +
    • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
      • +
    • querySelectorAll<E>(selectors: string): NodeListOf<E>
      • +
    +
      +
    • + +
      +
      +

      Returns all element descendants of node that match selectors.

      +
      +
      +

      Type parameters

      +
        +
      • +

        K: "object" | "input" | "progress" | "select" | "a" | "abbr" | "address" | "applet" | "area" | "article" | "aside" | "audio" | "b" | "base" | "basefont" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "dir" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "font" | "footer" | "form" | "frame" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "marquee" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "slot" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns NodeListOf<HTMLElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        K: "symbol" | "a" | "script" | "style" | "title" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view"

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: K
        +
        • +
      +

      Returns NodeListOf<SVGElementTagNameMap[K]>

      +
      • +
    • + +

      Type parameters

      +
        +
      • +

        E: Element = Element

        +
        • +
      +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns NodeListOf<E>

      +
      • +
    +
    +
    + +

    releasePointerCapture

    +
      +
    • releasePointerCapture(pointerId: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    remove

    +
      +
    • remove(): void
      • +
    +
      +
    • + +
      +
      +

      Removes node.

      +
      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttribute

    +
      +
    • removeAttribute(qualifiedName: string): void
      • +
    +
      +
    • + +
      +
      +

      Removes element's first attribute whose qualified name is qualifiedName.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttributeNS

    +
      +
    • removeAttributeNS(namespace: null | string, localName: string): void
      • +
    +
      +
    • + +
      +
      +

      Removes element's attribute whose namespace is namespace and local name is localName.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        localName: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    removeAttributeNode

    +
      +
    • removeAttributeNode(attr: Attr): Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns Attr

      +
      • +
    +
    +
    + +

    removeChild

    +
      +
    • removeChild<T>(oldChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        oldChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    removeEventListener

    +
      +
    • removeEventListener<K>(type: K, listener: (ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void
      • +
    • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

        +
        • +
      +

      Parameters

      +
        +
      • +
        type: K
        +
        • +
      • +
        listener: (ev: HTMLElementEventMap[K]) => any
        +
          +
        • +
            +
          • (ev: HTMLElementEventMap[K]): any
            • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              ev: HTMLElementEventMap[K]
              +
              • +
            +

            Returns any

            +
            • +
          +
          • +
        +
        • +
      • +
        Optional options: boolean | EventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        type: string
        +
        • +
      • +
        listener: EventListenerOrEventListenerObject
        +
        • +
      • +
        Optional options: boolean | EventListenerOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    replaceChild

    +
      +
    • replaceChild<T>(newChild: Node, oldChild: T): T
      • +
    +
      +
    • + +

      Type parameters

      +
        +
      • +

        T: Node

        +
        • +
      +

      Parameters

      +
        +
      • +
        newChild: Node
        +
        • +
      • +
        oldChild: T
        +
        • +
      +

      Returns T

      +
      • +
    +
    +
    + +

    replaceWith

    +
      +
    • replaceWith(...nodes: (string | Node)[]): void
      • +
    +
      +
    • + +
      +
      +

      Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

      +
      +

      Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

      +
      +

      Parameters

      +
        +
      • +
        Rest ...nodes: (string | Node)[]
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    requestFullscreen

    +
      +
    • requestFullscreen(options?: FullscreenOptions): Promise<void>
      • +
    +
      +
    • + +
      +
      +

      Displays element fullscreen and resolves promise when done.

      +
      +

      When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

      +
      +

      Parameters

      +
        +
      • +
        Optional options: FullscreenOptions
        +
        • +
      +

      Returns Promise<void>

      +
      • +
    +
    +
    + +

    requestPointerLock

    +
      +
    • requestPointerLock(): void
      • +
    +
      +
    • + +

      Returns void

      +
      • +
    +
    +
    + +

    scroll

    +
      +
    • scroll(options?: ScrollToOptions): void
      • +
    • scroll(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollBy

    +
      +
    • scrollBy(options?: ScrollToOptions): void
      • +
    • scrollBy(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollIntoView

    +
      +
    • scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional arg: boolean | ScrollIntoViewOptions
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    scrollTo

    +
      +
    • scrollTo(options?: ScrollToOptions): void
      • +
    • scrollTo(x: number, y: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        Optional options: ScrollToOptions
        +
        • +
      +

      Returns void

      +
      • +
    • + +

      Parameters

      +
        +
      • +
        x: number
        +
        • +
      • +
        y: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttribute

    +
      +
    • setAttribute(qualifiedName: string, value: string): void
      • +
    +
      +
    • + +
      +
      +

      Sets the value of element's first attribute whose qualified name is qualifiedName to value.

      +
      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      • +
        value: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttributeNS

    +
      +
    • setAttributeNS(namespace: null | string, qualifiedName: string, value: string): void
      • +
    +
      +
    • + +
      +
      +

      Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

      +
      +
      +

      Parameters

      +
        +
      • +
        namespace: null | string
        +
        • +
      • +
        qualifiedName: string
        +
        • +
      • +
        value: string
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    setAttributeNode

    +
      +
    • setAttributeNode(attr: Attr): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    setAttributeNodeNS

    +
      +
    • setAttributeNodeNS(attr: Attr): null | Attr
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        attr: Attr
        +
        • +
      +

      Returns null | Attr

      +
      • +
    +
    +
    + +

    setPointerCapture

    +
      +
    • setPointerCapture(pointerId: number): void
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        pointerId: number
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    + +

    toggleAttribute

    +
      +
    • toggleAttribute(qualifiedName: string, force?: boolean): boolean
      • +
    +
      +
    • + +
      +
      +

      If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

      +
      +

      Returns true if qualifiedName is now present, and false otherwise.

      +
      +

      Parameters

      +
        +
      • +
        qualifiedName: string
        +
        • +
      • +
        Optional force: boolean
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    + +

    webkitMatchesSelector

    +
      +
    • webkitMatchesSelector(selectors: string): boolean
      • +
    +
      +
    • + +

      Parameters

      +
        +
      • +
        selectors: string
        +
        • +
      +

      Returns boolean

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    +
      +
    • Property
      • +
    +
      +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + \ No newline at end of file diff --git a/master/classes/sourceapi.html b/master/classes/sourceapi.html new file mode 100644 index 000000000..d4a00ca4b --- /dev/null +++ b/master/classes/sourceapi.html @@ -0,0 +1,410 @@ + + + + + + SourceAPI | ruffle-core + + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class SourceAPI

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Represents this particular version of Ruffle.

    +
    +

    Multiple APIs can be instantiated from different sources; e.g. an "extension" + version, versus a "local" version. This expresses to the Public API + negotiator (see PublicAPI) what this particular version of Ruffle is and + how to control it.

    +
    +
    +
    +

    Hierarchy

    +
      +
    • + SourceAPI +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Accessors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Accessors

    +
    + +

    version

    +
      +
    • get version(): string
      • +
    +
      +
    • + +
      +
      +

      The version of this particular API.

      +
      +

      This is returned as a string in a semver compatible format.

      +
      +

      Returns string

      +

      The version of this Ruffle source

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    createPlayer

    + +
      +
    • + +
      +
      +

      Create a Ruffle player element using this particular version of Ruffle.

      +
      +
      +

      Returns RufflePlayer

      +

      The player element. This is a DOM element that may be inserted + into the current page as you wish.

      +
      • +
    +
    +
    + +

    pluginPolyfill

    +
      +
    • pluginPolyfill(): void
      • +
    +
      +
    • + +
      +
      +

      Polyfill the plugin detection.

      +
      +

      This needs to run before any plugin detection script does.

      +
      +

      Returns void

      +
      • +
    +
    +
    + +

    polyfill

    +
      +
    • polyfill(isExt: boolean): void
      • +
    +
      +
    • + +
      +
      +

      Start up the polyfills.

      +
      +

      Do not run polyfills for more than one Ruffle source at a time.

      +
      +

      Parameters

      +
        +
      • +
        isExt: boolean
        +
        +

        Whether or not Ruffle is running as a browser's extension.

        +
        +
        • +
      +

      Returns void

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    +
      +
    • Property
      • +
    +
      +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + \ No newline at end of file diff --git a/master/classes/version.html b/master/classes/version.html new file mode 100644 index 000000000..477c026fc --- /dev/null +++ b/master/classes/version.html @@ -0,0 +1,504 @@ + + + + + + Version | ruffle-core + + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class Version

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    A representation of a semver 2 compliant version string

    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + Version +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    +
      +
    • new Version(major: number, minor: number, patch: number, prIdent: null | string[], buildIdent: null | string[]): Version
      • +
    +
      +
    • + +
      +
      +

      Construct a Version from specific components.

      +
      +

      If you wish to parse a string into a Version then please use fromSemver.

      +
      +

      Parameters

      +
        +
      • +
        major: number
        +
        +

        The major version component.

        +
        +
        • +
      • +
        minor: number
        +
        +

        The minor version component.

        +
        +
        • +
      • +
        patch: number
        +
        +

        The patch version component.

        +
        +
        • +
      • +
        prIdent: null | string[]
        +
        +

        A list of pre-release identifiers, if any

        +
        +
        • +
      • +
        buildIdent: null | string[]
        +
        +

        A list of build identifiers, if any

        +
        +
        • +
      +

      Returns Version

      +
      • +
    +
    +
    +
    +

    Methods

    +
    + +

    hasPrecedenceOver

    +
      +
    • hasPrecedenceOver(other: Version): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if this version has precedence over (is newer than) another + version.

      +
      +

      Precedence is defined as in the Semver 2 spec. This implements the > + operator in npm's semver package, with the exception of the prerelease + exclusion rule.

      +
      +

      Parameters

      +
        +
      • +
        other: Version
        +
        +

        The other version to test against

        +
        +
        • +
      +

      Returns boolean

      +

      True if this version has precedence over the other one

      +
      • +
    +
    +
    + +

    isCompatibleWith

    +
      +
    • isCompatibleWith(other: Version): boolean
      • +
    +
      +
    • + +
      +
      +

      Returns true if a given version is compatible with this one.

      +
      +

      Compatibility is defined as having the same nonzero major version + number, or if both major versions are zero, the same nonzero minor + version number, or if both minor versions are zero, the same nonzero + patch version number.

      +

      This implements the ^ operator in npm's semver package, with the + exception of the prerelease exclusion rule.

      +
      +

      Parameters

      +
        +
      • +
        other: Version
        +
        +

        The other version to test against

        +
        +
        • +
      +

      Returns boolean

      +

      True if compatible

      +
      • +
    +
    +
    + +

    isEqual

    +
      +
    • isEqual(other: Version): boolean
      • +
    +
      +
    • + +
      +
      +

      Tests if a given version is equivalent to this one.

      +
      +

      Build and prerelease tags are ignored.

      +
      +

      Parameters

      +
        +
      • +
        other: Version
        +
        +

        The other version to test against

        +
        +
        • +
      +

      Returns boolean

      +

      True if the given version is equivalent

      +
      • +
    +
    +
    + +

    isStableOrCompatiblePrerelease

    +
      +
    • isStableOrCompatiblePrerelease(other: Version): boolean
      • +
    +
      +
    • + +
      +
      +

      Tests if a given version is stable or a compatible prerelease for this + version.

      +
      +

      This implements the prerelease exclusion rule of NPM semver: a + prerelease version can only pass this check if the major/minor/patch + components of both versions are the same. Otherwise, the prerelease + version always fails.

      +
      +

      Parameters

      +
        +
      • +
        other: Version
        +
        +

        The other version to test against

        +
        +
        • +
      +

      Returns boolean

      +

      True if the given version is either stable, or a + prerelease in the same series as this one.

      +
      • +
    +
    +
    + +

    Static fromSemver

    +
      +
    • fromSemver(versionString: string): Version
      • +
    +
      +
    • + +
      +
      +

      Construct a version from a semver 2 compliant string.

      +
      +

      This function is intended for use with semver 2 compliant strings. + Malformed strings may still parse correctly, but this result is not + guaranteed.

      +
      +

      Parameters

      +
        +
      • +
        versionString: string
        +
        +

        A semver 2.0.0 compliant version string

        +
        +
        • +
      +

      Returns Version

      +

      A version object

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    +
      +
    • Property
      • +
    +
      +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + \ No newline at end of file diff --git a/master/classes/versionrange.html b/master/classes/versionrange.html new file mode 100644 index 000000000..4048b1d1a --- /dev/null +++ b/master/classes/versionrange.html @@ -0,0 +1,396 @@ + + + + + + VersionRange | ruffle-core + + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class VersionRange

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    Represents a set of version requirements.

    +
    +
    +
    +
    +

    Hierarchy

    +
      +
    • + VersionRange +
      • +
    +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Properties

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    +
      +
    • new VersionRange(requirements: Requirement[][]): VersionRange
      • +
    +
      +
    • + +
      +
      +

      Constructs a range of versions as specified by the given requirements.

      +
      +

      If you wish to construct this object from a string representation, + then use fromRequirementString.

      +
      +

      Parameters

      +
        +
      • +
        requirements: Requirement[][]
        +
        +

        Requirements to set this range by

        +
        +
        • +
      +

      Returns VersionRange

      +
      • +
    +
    +
    +
    +

    Properties

    +
    + +

    Readonly requirements

    +
    requirements: Requirement[][]
    + +
    +
    +

    The list of requirements used by this version range.

    +
    +

    This is a disjunctive normal form - that is, an OR of ANDs.

    +

    If all requirements of a single inner array match, the range is + considered successful.

    +
    +
    +
    +
    +

    Methods

    +
    + +

    satisfiedBy

    +
      +
    • satisfiedBy(fver: Version): boolean
      • +
    +
      +
    • + +
      +
      +

      Determine if a given version satisfies this range.

      +
      +
      +

      Parameters

      +
        +
      • +
        fver: Version
        +
        +

        A version object to test against.

        +
        +
        • +
      +

      Returns boolean

      +

      Whether or not the given version matches this range

      +
      • +
    +
    +
    + +

    Static fromRequirementString

    +
      +
    • fromRequirementString(requirement: string): VersionRange
      • +
    +
      +
    • + +
      +
      +

      Parse a requirement string into a version range.

      +
      +
      +

      Parameters

      +
        +
      • +
        requirement: string
        +
        +

        The version requirements, consisting of a + series of space-separated strings, each one being a semver version + optionally prefixed by a comparator or a separator.

        +

        Valid comparators are:

        +
          +
        • "" or "=": Precisely this version
          • +
        • ">": A version newer than this one
          • +
        • ">=": A version newer or equal to this one
          • +
        • "<": A version older than this one
          • +
        • "<=": A version older or equal to this one
          • +
        • "^": A version that is compatible with this one
          • +
        +

        A separator is "||" which splits the requirement string into + left OR right.

        +
        +
        • +
      +

      Returns VersionRange

      +

      A version range object.

      +
      • +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    +
      +
    • Property
      • +
    +
      +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + \ No newline at end of file diff --git a/master/enums/Config.AutoPlay.html b/master/enums/Config.AutoPlay.html deleted file mode 100644 index 89c44f3f9..000000000 --- a/master/enums/Config.AutoPlay.html +++ /dev/null @@ -1,15 +0,0 @@ -AutoPlay | ruffle-core
    ruffle-core
      Preparing search index...

      Enumeration AutoPlay

      Represents the various types of auto-play behaviours that are supported.

      -
      Index

      Enumeration Members

      On -Off -Auto -

      Enumeration Members

      On: "on"

      The player should automatically play the movie as soon as it is loaded.

      -

      If the browser does not support automatic audio, the movie will begin -muted.

      -
      Off: "off"

      The player should not attempt to automatically play the movie.

      -

      This will leave it to the user or API to actually play when appropriate.

      -
      Auto: "auto"

      The player should automatically play the movie as soon as it is deemed -"appropriate" to do so.

      -

      The exact behaviour depends on the browser, but commonly requires some -form of user interaction on the page in order to allow auto playing videos -with sound.

      -

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      diff --git a/master/enums/Config.ContextMenu.html b/master/enums/Config.ContextMenu.html deleted file mode 100644 index f0282f03e..000000000 --- a/master/enums/Config.ContextMenu.html +++ /dev/null @@ -1,11 +0,0 @@ -ContextMenu | ruffle-core
      ruffle-core
        Preparing search index...

        Enumeration ContextMenu

        Represents the various context menu options that are supported.

        -
        Index

        Enumeration Members

        On -RightClickOnly -Off -

        Enumeration Members

        On: "on"

        The context menu should appear when right-clicking or long-pressing -the Ruffle instance.

        -
        RightClickOnly: "rightClickOnly"

        The context menu should only appear when right-clicking -the Ruffle instance.

        -
        Off: "off"

        The context menu should not appear when right-clicking or long-pressing -the Ruffle instance.

        -

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        diff --git a/master/enums/Config.GamepadButton.html b/master/enums/Config.GamepadButton.html deleted file mode 100644 index 52963e883..000000000 --- a/master/enums/Config.GamepadButton.html +++ /dev/null @@ -1,15 +0,0 @@ -GamepadButton | ruffle-core
        ruffle-core
          Preparing search index...

          Enumeration GamepadButtonExperimental

          Index

          Enumeration Members

          South -East -North -West -LeftTrigger -LeftTrigger2 -RightTrigger -RightTrigger2 -Select -Start -DPadUp -DPadDown -DPadLeft -DPadRight -

          Enumeration Members

          South: "south"
          East: "east"
          North: "north"
          West: "west"
          LeftTrigger: "left-trigger"
          LeftTrigger2: "left-trigger-2"
          RightTrigger: "right-trigger"
          RightTrigger2: "right-trigger-2"
          Select: "select"
          Start: "start"
          DPadUp: "dpad-up"
          DPadDown: "dpad-down"
          DPadLeft: "dpad-left"
          DPadRight: "dpad-right"

          Settings

          Member Visibility

          On This Page

          Enumeration Members
          diff --git a/master/enums/Config.Letterbox.html b/master/enums/Config.Letterbox.html deleted file mode 100644 index cbc5d01ea..000000000 --- a/master/enums/Config.Letterbox.html +++ /dev/null @@ -1,11 +0,0 @@ -Letterbox | ruffle-core
          ruffle-core
            Preparing search index...

            Enumeration Letterbox

            Controls whether the content is letterboxed or pillarboxed when the -player's aspect ratio does not match the movie's aspect ratio.

            -

            When letterboxed, black bars will be rendered around the exterior -margins of the content.

            -
            Index

            Enumeration Members

            Off -Fullscreen -On -

            Enumeration Members

            Off: "off"

            The content will never be letterboxed.

            -
            Fullscreen: "fullscreen"

            The content will only be letterboxed if the content is running fullscreen.

            -
            On: "on"

            The content will always be letterboxed.

            -

            Settings

            Member Visibility

            On This Page

            Enumeration Members
            diff --git a/master/enums/Config.LogLevel.html b/master/enums/Config.LogLevel.html deleted file mode 100644 index 7225bfb30..000000000 --- a/master/enums/Config.LogLevel.html +++ /dev/null @@ -1,7 +0,0 @@ -LogLevel | ruffle-core
            ruffle-core
              Preparing search index...

              Enumeration LogLevel

              Console logging level.

              -
              Index

              Enumeration Members

              Error -Warn -Info -Debug -Trace -

              Enumeration Members

              Error: "error"
              Warn: "warn"
              Info: "info"
              Debug: "debug"
              Trace: "trace"

              Settings

              Member Visibility

              On This Page

              Enumeration Members
              diff --git a/master/enums/Config.NetworkingAccessMode.html b/master/enums/Config.NetworkingAccessMode.html deleted file mode 100644 index 0850c0e74..000000000 --- a/master/enums/Config.NetworkingAccessMode.html +++ /dev/null @@ -1,18 +0,0 @@ -NetworkingAccessMode | ruffle-core
              ruffle-core
                Preparing search index...

                Enumeration NetworkingAccessMode

                The networking API access mode of the Ruffle player.

                -
                Index

                Enumeration Members

                All -Internal -None -

                Enumeration Members

                All: "all"

                All networking APIs are permitted in the SWF file.

                -
                Internal: "internal"

                The SWF file may not call browser navigation or browser interaction APIs.

                -

                The APIs navigateToURL(), fscommand() and ExternalInterface.call() are -prevented in this mode.

                -
                None: "none"

                The SWF file may not call browser navigation or browser interaction APIs -and it cannot use any SWF-to-SWF communication APIs.

                -

                Additionally to the ones in internal mode, the APIs sendToURL(), -FileReference.download(), FileReference.upload(), Loader.load(), -LocalConnection.connect(), LocalConnection.send(), NetConnection.connect(), -NetStream.play(), Security.loadPolicyFile(), SharedObject.getLocal(), -SharedObject.getRemote(), Socket.connect(), Sound.load(), URLLoader.load(), -URLStream.load() and XMLSocket.connect() are prevented in this mode.

                -

                This mode is not implemented yet.

                -

                Settings

                Member Visibility

                On This Page

                Enumeration Members
                diff --git a/master/enums/Config.OpenURLMode.html b/master/enums/Config.OpenURLMode.html deleted file mode 100644 index aa1c87a49..000000000 --- a/master/enums/Config.OpenURLMode.html +++ /dev/null @@ -1,8 +0,0 @@ -OpenURLMode | ruffle-core
                ruffle-core
                  Preparing search index...

                  Enumeration OpenURLMode

                  The handling mode of links opening a new website.

                  -
                  Index

                  Enumeration Members

                  Allow -Confirm -Deny -

                  Enumeration Members

                  Allow: "allow"

                  Allow all links to open a new website.

                  -
                  Confirm: "confirm"

                  A confirmation dialog opens with every link trying to open a new website.

                  -
                  Deny: "deny"

                  Deny all links to open a new website.

                  -

                  Settings

                  Member Visibility

                  On This Page

                  Enumeration Members
                  diff --git a/master/enums/Config.PlayerRuntime.html b/master/enums/Config.PlayerRuntime.html deleted file mode 100644 index b6a1b4cb8..000000000 --- a/master/enums/Config.PlayerRuntime.html +++ /dev/null @@ -1,6 +0,0 @@ -PlayerRuntime | ruffle-core
                  ruffle-core
                    Preparing search index...

                    Enumeration PlayerRuntime

                    Represents the player runtime to emulate.

                    -
                    Index

                    Enumeration Members

                    AIR -FlashPlayer -

                    Enumeration Members

                    AIR: "air"

                    Emulate Adobe AIR.

                    -
                    FlashPlayer: "flashPlayer"

                    Emulate Adobe Flash Player.

                    -

                    Settings

                    Member Visibility

                    On This Page

                    Enumeration Members
                    diff --git a/master/enums/Config.RenderBackend.html b/master/enums/Config.RenderBackend.html deleted file mode 100644 index fe4697d62..000000000 --- a/master/enums/Config.RenderBackend.html +++ /dev/null @@ -1,19 +0,0 @@ -RenderBackend | ruffle-core
                    ruffle-core
                      Preparing search index...

                      Enumeration RenderBackend

                      The render backend of a Ruffle player.

                      -

                      The available backends may change in future releases.

                      -
                      Index

                      Enumeration Members

                      WebGpu -WgpuWebgl -Webgl -Canvas -

                      Enumeration Members

                      WebGpu: "webgpu"

                      An in-development API that will be preferred if available in the future. -Should behave the same as wgpu-webgl, except with lower overhead and thus better performance.

                      -
                      WgpuWebgl: "wgpu-webgl"

                      The most featureful and currently preferred backend. -Rendering is done the same way as in the desktop app, then translated to WebGL on-the-fly.

                      -
                      Webgl: "webgl"

                      A vanilla WebGL backend. Was the default backend until the start of 2023, -but is now used as a fallback for devices that do not support WebGL 2. -Supports fewer features and has a faster initialization time; -may be useful for content that does not need advanced features like bitmap drawing or blend modes.

                      -
                      Canvas: "canvas"

                      The slowest and most basic backend, used as a fallback when all else fails. -However, this is currently the only backend that accurately scales hairline strokes. -If you notice excessively thick strokes in specific content, -you may want to use the canvas renderer for that content until the issue is resolved.

                      -

                      Settings

                      Member Visibility

                      On This Page

                      Enumeration Members
                      diff --git a/master/enums/Config.ScrollingBehavior.html b/master/enums/Config.ScrollingBehavior.html deleted file mode 100644 index aa3d7151e..000000000 --- a/master/enums/Config.ScrollingBehavior.html +++ /dev/null @@ -1,8 +0,0 @@ -ScrollingBehavior | ruffle-core
                      ruffle-core
                        Preparing search index...

                        Enumeration ScrollingBehavior

                        The behavior of scrolling the web page.

                        -
                        Index

                        Enumeration Members

                        Always -Never -Smart -

                        Enumeration Members

                        Always: "always"

                        Always scroll the page.

                        -
                        Never: "never"

                        Never scroll the page.

                        -
                        Smart: "smart"

                        Scroll the page only when the Flash content hasn't handled the scroll.

                        -

                        Settings

                        Member Visibility

                        On This Page

                        Enumeration Members
                        diff --git a/master/enums/Config.UnmuteOverlay.html b/master/enums/Config.UnmuteOverlay.html deleted file mode 100644 index 7bbfbea0f..000000000 --- a/master/enums/Config.UnmuteOverlay.html +++ /dev/null @@ -1,7 +0,0 @@ -UnmuteOverlay | ruffle-core
                        ruffle-core
                          Preparing search index...

                          Enumeration UnmuteOverlay

                          When the player is muted, this controls whether or not Ruffle will show a -"click to unmute" overlay on top of the movie.

                          -
                          Index

                          Enumeration Members

                          Visible -Hidden -

                          Enumeration Members

                          Visible: "visible"

                          Show an overlay explaining that the movie is muted.

                          -
                          Hidden: "hidden"

                          Don't show an overlay and pretend that everything is fine.

                          -

                          Settings

                          Member Visibility

                          On This Page

                          Enumeration Members
                          diff --git a/master/enums/Config.WindowMode.html b/master/enums/Config.WindowMode.html deleted file mode 100644 index b0927145c..000000000 --- a/master/enums/Config.WindowMode.html +++ /dev/null @@ -1,19 +0,0 @@ -WindowMode | ruffle-core
                          ruffle-core
                            Preparing search index...

                            Enumeration WindowMode

                            The window mode of a Ruffle player.

                            -
                            Index

                            Enumeration Members

                            Window -Opaque -Transparent -Direct -Gpu -

                            Enumeration Members

                            Window: "window"

                            The Flash content is rendered in its own window and layering is done with the browser's -default behavior.

                            -

                            In Ruffle, this mode functions like WindowMode::Opaque and will layer the Flash content -together with other HTML elements.

                            -
                            Opaque: "opaque"

                            The Flash content is layered together with other HTML elements, and the stage color is -opaque. Content can render above or below Ruffle based on CSS rendering order.

                            -
                            Transparent: "transparent"

                            The Flash content is layered together with other HTML elements, and the SWF stage color is -transparent. Content beneath Ruffle will be visible through transparent areas.

                            -
                            Direct: "direct"

                            Request compositing with hardware acceleration when possible. -This mode has no effect in Ruffle and will function like WindowMode.Opaque.

                            -
                            Gpu: "gpu"

                            Request a direct rendering path, bypassing browser compositing when possible. -This mode has no effect in Ruffle and will function like WindowMode::Opaque.

                            -

                            Settings

                            Member Visibility

                            On This Page

                            Enumeration Members
                            diff --git a/master/enums/Player.ReadyState.html b/master/enums/Player.ReadyState.html deleted file mode 100644 index 857d9f676..000000000 --- a/master/enums/Player.ReadyState.html +++ /dev/null @@ -1,8 +0,0 @@ -ReadyState | ruffle-core
                            ruffle-core
                              Preparing search index...

                              Enumeration ReadyState

                              Describes the loading state of an SWF movie.

                              -
                              Index

                              Enumeration Members

                              HaveNothing -Loading -Loaded -

                              Enumeration Members

                              HaveNothing: 0

                              No movie is loaded, or no information is yet available about the movie.

                              -
                              Loading: 1

                              The movie is still loading, but it has started playback, and metadata is available.

                              -
                              Loaded: 2

                              The movie has completely loaded.

                              -

                              Settings

                              Member Visibility

                              On This Page

                              Enumeration Members
                              diff --git a/master/enums/autoplay.html b/master/enums/autoplay.html new file mode 100644 index 000000000..b43ca7373 --- /dev/null +++ b/master/enums/autoplay.html @@ -0,0 +1,285 @@ + + + + + + AutoPlay | ruffle-core + + + + + + +
                              +
                              +
                              +
                              + +
                              +
                              + Options +
                              +
                              + All +
                                +
                              • Public
                                • +
                              • Public/Protected
                                • +
                              • All
                                • +
                              +
                              + + + + +
                              +
                              + Menu +
                              +
                              +
                              +
                              +
                              +
                              + +

                              Enumeration AutoPlay

                              +
                              +
                              +
                              +
                              +
                              +
                              +
                              +

                              Index

                              +
                              +
                              +
                              +

                              Enumeration members

                              + +
                              +
                              +
                              +
                              +
                              +

                              Enumeration members

                              +
                              + +

                              Auto

                              +
                              Auto: = "auto"
                              + +
                              +
                              +

                              The player should automatically play the movie as soon as it is deemed + "appropriate" to do so.

                              +
                              +

                              The exact behaviour depends on the browser, but commonly requires some + form of user interaction on the page in order to allow auto playing videos + with sound.

                              +
                              +
                              +
                              + +

                              Off

                              +
                              Off: = "off"
                              + +
                              +
                              +

                              The player should not attempt to automatically play the movie.

                              +
                              +

                              This will leave it to the user or API to actually play when appropriate.

                              +
                              +
                              +
                              + +

                              On

                              +
                              On: = "on"
                              + +
                              +
                              +

                              The player should automatically play the movie as soon as it is loaded.

                              +
                              +

                              If the browser does not support automatic audio, the movie will begin + muted.

                              +
                              +
                              +
                              +
                              +
                              + + +
                              +
                              +
                              +
                              +
                              +

                              Legend

                              +
                              +
                                +
                              • Constructor
                                • +
                              • Property
                                • +
                              • Method
                                • +
                              +
                                +
                              • Inherited constructor
                                • +
                              • Inherited property
                                • +
                              • Inherited method
                                • +
                              +
                                +
                              • Property
                                • +
                              +
                                +
                              • Static method
                                • +
                              +
                              +
                              +
                              +
                              +

                              Generated using TypeDoc

                              +
                              +
                              + + + \ No newline at end of file diff --git a/master/enums/unmuteoverlay.html b/master/enums/unmuteoverlay.html new file mode 100644 index 000000000..ad23eae0f --- /dev/null +++ b/master/enums/unmuteoverlay.html @@ -0,0 +1,267 @@ + + + + + + UnmuteOverlay | ruffle-core + + + + + + +
                              +
                              +
                              +
                              + +
                              +
                              + Options +
                              +
                              + All +
                                +
                              • Public
                                • +
                              • Public/Protected
                                • +
                              • All
                                • +
                              +
                              + + + + +
                              +
                              + Menu +
                              +
                              +
                              +
                              +
                              +
                              + +

                              Enumeration UnmuteOverlay

                              +
                              +
                              +
                              +
                              +
                              +
                              +
                              +
                              +
                              +

                              When the player is muted, this controls whether or not Ruffle will show a + "click to unmute" overlay on top of the movie.

                              +
                              +
                              +
                              +
                              +

                              Index

                              +
                              +
                              +
                              +

                              Enumeration members

                              + +
                              +
                              +
                              +
                              +
                              +

                              Enumeration members

                              +
                              + +

                              Hidden

                              +
                              Hidden: = "hidden"
                              + +
                              +
                              +

                              Don't show an overlay and pretend that everything is fine.

                              +
                              +
                              +
                              +
                              + +

                              Visible

                              +
                              Visible: = "visible"
                              + +
                              +
                              +

                              Show an overlay explaining that the movie is muted.

                              +
                              +
                              +
                              +
                              +
                              +
                              + + +
                              +
                              +
                              +
                              +
                              +

                              Legend

                              +
                              +
                                +
                              • Constructor
                                • +
                              • Property
                                • +
                              • Method
                                • +
                              +
                                +
                              • Inherited constructor
                                • +
                              • Inherited property
                                • +
                              • Inherited method
                                • +
                              +
                                +
                              • Property
                                • +
                              +
                                +
                              • Static method
                                • +
                              +
                              +
                              +
                              +
                              +

                              Generated using TypeDoc

                              +
                              +
                              + + + \ No newline at end of file diff --git a/master/functions/Setup.installRuffle.html b/master/functions/Setup.installRuffle.html deleted file mode 100644 index e99de3bd1..000000000 --- a/master/functions/Setup.installRuffle.html +++ /dev/null @@ -1,11 +0,0 @@ -installRuffle | ruffle-core
                              ruffle-core
                                Preparing search index...

                                Function installRuffle

                                • Install this version of Ruffle into the current page.

                                  -

                                  Multiple (or zero) versions of Ruffle may be installed at the same time, -and you should use window.RufflePlayer.newest() or similar to access the appropriate -installation at time of use.

                                  -

                                  Parameters

                                  • sourceName: string

                                    The name of this particular -Ruffle source. Common convention is "local" for websites that bundle their own Ruffle, -"extension" for browser extensions, and something else for other use cases. -Names are unique, and last-installed will replace earlier installations with the same name, -regardless of what those installations are or which version they represent.

                                    -
                                  • options: InstallationOptions = {}

                                    Any options used to configure this specific installation of Ruffle.

                                    -

                                  Returns void

                                Settings

                                Member Visibility
                                diff --git a/master/functions/setCurrentScriptURL.html b/master/functions/setCurrentScriptURL.html deleted file mode 100644 index 426ba1c64..000000000 --- a/master/functions/setCurrentScriptURL.html +++ /dev/null @@ -1,3 +0,0 @@ -setCurrentScriptURL | ruffle-core
                                ruffle-core
                                  Preparing search index...

                                  Function setCurrentScriptURL

                                  • Sets the current script URL and isExtension boolean manually when using the extension.

                                    -

                                    Parameters

                                    • src: URL

                                      The location of Ruffle's resources within the extension.

                                      -

                                    Returns void

                                  Settings

                                  Member Visibility
                                  diff --git a/master/hierarchy.html b/master/hierarchy.html deleted file mode 100644 index 56ea8c5cf..000000000 --- a/master/hierarchy.html +++ /dev/null @@ -1 +0,0 @@ -ruffle-core
                                  ruffle-core
                                    Preparing search index...

                                    ruffle-core

                                    Hierarchy Summary

                                    Settings

                                    Member Visibility
                                    diff --git a/master/index.html b/master/index.html index b571e736c..2b300e202 100644 --- a/master/index.html +++ b/master/index.html @@ -1,23 +1,243 @@ -ruffle-core
                                    ruffle-core
                                      Preparing search index...

                                      ruffle-core

                                      ruffle-core

                                      ruffle-core is the core javascript bindings to the Wasm ruffle-web binary, -and contains the actual public API.

                                      -

                                      For more examples and in-depth documentation on how to use Ruffle on your website, please -check out our wiki.

                                      -

                                      The core package is configured for websites that build and bundle their files themselves. -Simply add ruffle to an npm package, and use something like Webpack to actually bundle and serve -the files.

                                      -

                                      If you wish to use Ruffle on a website that doesn't use npm, we have a pre-bundled version which -we call 'selfhosted'. Please refer to its documentation.

                                      -

                                      Please note that the .wasm file must be served properly, and some web servers may not do that -correctly out of the box. Please see our wiki -for instructions on how to configure this, if you encounter a Incorrect response MIME type error.

                                      -

                                      If you have an existing website with flash content, you can simply include Ruffle as a script and -our polyfill magic will replace everything for you. No fuss, no mess.

                                      -
                                      <script src="path/to/ruffle/ruffle.js"></script>
-
                                      + + + + + + ruffle-core + + + + + + +
                                      +
                                      +
                                      +
                                      + +
                                      +
                                      + Options +
                                      +
                                      + All +
                                        +
                                      • Public
                                        • +
                                      • Public/Protected
                                        • +
                                      • All
                                        • +
                                      +
                                      + + + + +
                                      +
                                      + Menu +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Project ruffle-core

                                      +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + +

                                      ruffle-core

                                      +                                       +

                                      ruffle-core is the core javascript bindings to the Wasm ruffle-web binary, + and contains the actual public API.

                                      + +

                                      Using ruffle-core

                                      +                                       +

                                      For more examples and in-depth documentation on how to use Ruffle on your website, please + check out our wiki.

                                      + +

                                      Host Ruffle

                                      +                                       +

                                      The core package is configured for websites that build and bundle their files themselves. + Simply add ruffle to an npm package, and use something like Webpack to actually bundle and serve + the files.

                                      +

                                      If you wish to use Ruffle on a website that doesn't use npm, we have a pre-bundled version which + we call 'selfhosted'. Please refer to its documentation.

                                      +

                                      Please note that the .wasm file must be served properly, and some web servers may not do that + correctly out of the box. Please see our wiki + for instructions on how to configure this, if you encounter a Incorrect response MIME type error.

                                      + +

                                      "Plug and Play"

                                      +                                       +

                                      If you have an existing website with flash content, you can simply include Ruffle as a script and + our polyfill magic will replace everything for you. No fuss, no mess.

                                      + 
                                      <script src="path/to/ruffle/ruffle.js"></script>
+
                                      + +

                                      Javascript API

                                      +                                       +

                                      If you want to control the Ruffle player, you may use our Javascript API.

                                      + 
                                      <script>
+    window.RufflePlayer = window.RufflePlayer || {};
 
-
                                      If you want to control the Ruffle player, you may use our Javascript API.
                                      
-
                                      <script>
                                          window.RufflePlayer = window.RufflePlayer || {};

                                          window.addEventListener("DOMContentLoaded", () => {
                                              let ruffle = window.RufflePlayer.newest();
                                              let player = ruffle.createPlayer();
                                              let container = document.getElementById("container");
                                              container.appendChild(player);
                                              player.ruffle().load("movie.swf");
                                          });
                                      </script>
                                      <script src="path/to/ruffle/ruffle.js"></script>
-
                                      
-
-
                                      Please see the ruffle-web README.
                                      
-

                                      Settings

                                      Member Visibility

                                      On This Page

                                      ruffle-core
                                      + window.addEventListener("DOMContentLoaded", () => { + let ruffle = window.RufflePlayer.newest(); + let player = ruffle.createPlayer(); + let container = document.getElementById("container"); + container.appendChild(player); + player.load("movie.swf"); + }); +</script> +<script src="path/to/ruffle/ruffle.js"></script> + + +

                                      Building, testing or contributing

                                      +                                       +

                                      Please see the ruffle-web README.

                                      +
                                      +
                                      +
                                      + + +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Legend

                                      +
                                      +
                                        +
                                      • Constructor
                                        • +
                                      • Property
                                        • +
                                      • Method
                                        • +
                                      +
                                        +
                                      • Inherited constructor
                                        • +
                                      • Inherited property
                                        • +
                                      • Inherited method
                                        • +
                                      +
                                        +
                                      • Property
                                        • +
                                      +
                                        +
                                      • Static method
                                        • +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Generated using TypeDoc

                                      +
                                      +
                                      + + + \ No newline at end of file diff --git a/master/interfaces/Config.BaseLoadOptions.html b/master/interfaces/Config.BaseLoadOptions.html deleted file mode 100644 index 0789f3d87..000000000 --- a/master/interfaces/Config.BaseLoadOptions.html +++ /dev/null @@ -1,275 +0,0 @@ -BaseLoadOptions | ruffle-core
                                      ruffle-core
                                        Preparing search index...

                                        Interface BaseLoadOptions

                                        Any options used for loading a movie.

                                        -
                                        interface BaseLoadOptions {
                                            allowScriptAccess?: boolean;
                                            parameters?: string | URLSearchParams | Record<string, string> | null;
                                            autoplay?: AutoPlay;
                                            backgroundColor?: string | null;
                                            letterbox?: Letterbox;
                                            unmuteOverlay?: UnmuteOverlay;
                                            upgradeToHttps?: boolean;
                                            compatibilityRules?: boolean;
                                            favorFlash?: boolean;
                                            warnOnUnsupportedContent?: boolean;
                                            logLevel?: LogLevel;
                                            showSwfDownload?: boolean;
                                            contextMenu?: boolean | ContextMenu;
                                            preloader?: boolean;
                                            splashScreen?: boolean;
                                            maxExecutionDuration?: Duration;
                                            base?: string | null;
                                            menu?: boolean;
                                            salign?: string;
                                            fullScreenAspectRatio?: string;
                                            forceAlign?: boolean;
                                            quality?: string | null;
                                            scale?: string;
                                            forceScale?: boolean;
                                            allowFullscreen?: boolean;
                                            frameRate?: number | null;
                                            wmode?: WindowMode;
                                            playerVersion?: number | null;
                                            preferredRenderer?: RenderBackend | null;
                                            publicPath?: string | null;
                                            polyfills?: boolean;
                                            openUrlMode?: OpenURLMode;
                                            allowNetworking?: NetworkingAccessMode;
                                            openInNewTab?: ((swf: URL) => void) | null;
                                            socketProxy?: SocketProxy[];
                                            fontSources?: string[];
                                            defaultFonts?: DefaultFonts;
                                            credentialAllowList?: string[];
                                            playerRuntime?: PlayerRuntime;
                                            gamepadButtonMapping?: Partial<Record<GamepadButton, number>>;
                                            urlRewriteRules?: [string | RegExp, string][];
                                            scrollingBehavior?: ScrollingBehavior;
                                        }

                                        Hierarchy (View Summary)

                                        Index

                                        Properties

                                        allowScriptAccess? -parameters? -autoplay? -backgroundColor? -letterbox? -unmuteOverlay? -upgradeToHttps? -compatibilityRules? -favorFlash? -warnOnUnsupportedContent? -logLevel? -showSwfDownload? -contextMenu? -preloader? -splashScreen? -maxExecutionDuration? -base? -menu? -salign? -fullScreenAspectRatio? -forceAlign? -quality? -scale? -forceScale? -allowFullscreen? -frameRate? -wmode? -playerVersion? -preferredRenderer? -publicPath? -polyfills? -openUrlMode? -allowNetworking? -openInNewTab? -socketProxy? -fontSources? -defaultFonts? -credentialAllowList? -playerRuntime? -gamepadButtonMapping? -urlRewriteRules? -scrollingBehavior? -

                                        Properties

                                        allowScriptAccess?: boolean

                                        If set to true, the movie is allowed to interact with the page through -JavaScript, using a flash concept called ExternalInterface.

                                        -

                                        This should only be enabled for movies you trust.

                                        -
                                        false
-
                                        - -
                                        parameters?: string | URLSearchParams | Record<string, string> | null

                                        Also known as "flashvars" - these are values that may be passed to -and loaded by the movie.

                                        -

                                        If a URL if specified when loading the movie, some parameters will -be extracted by the query portion of that URL and then overwritten -by any explicitly set here.

                                        -
                                        {}
-
                                        - -
                                        autoplay?: AutoPlay

                                        Controls the auto-play behaviour of Ruffle.

                                        -
                                        AutoPlay.Auto
-
                                        - -
                                        backgroundColor?: string | null

                                        Controls the background color of the player. -Must be an HTML color (e.g. "#FFFFFF"). CSS colors are not allowed. -null uses the background color of the SWF file.

                                        -
                                        null
-
                                        - -
                                        letterbox?: Letterbox

                                        Controls letterbox behavior when the Flash container size does not -match the movie size.

                                        -
                                        Letterbox.Fullscreen
-
                                        - -
                                        unmuteOverlay?: UnmuteOverlay

                                        Controls the visibility of the unmute overlay when the player -is started muted.

                                        -
                                        UnmuteOverlay.Visible
-
                                        - -
                                        upgradeToHttps?: boolean

                                        Whether or not to auto-upgrade all embedded URLs to https.

                                        -

                                        Flash content that embeds http urls will be blocked from -accessing those urls by the browser when Ruffle is loaded -in a https context. Set to true to automatically change -http:// to https:// for all embedded URLs when Ruffle is -loaded in an https context.

                                        -
                                        true
-
                                        - -
                                        compatibilityRules?: boolean

                                        Enable (true) or disable (false) Ruffle's built in compatibility rules.

                                        -

                                        These are rules that may make some content work by deliberately changing -behaviour, for example by rewriting requests or spoofing SWF urls if they -rely on websites that no longer exist.

                                        -
                                        true
-
                                        - -
                                        favorFlash?: boolean

                                        Favor using the real Adobe Flash Player over Ruffle if the browser supports it.

                                        -
                                        true
-
                                        - -
                                        warnOnUnsupportedContent?: boolean

                                        This is no longer used and does not affect anything. -It is only kept for backwards compatibility.

                                        -

                                        Previously: -"Whether or not to display an overlay with a warning when -loading a movie with unsupported content."

                                        -
                                        true
-
                                        - -
                                        logLevel?: LogLevel

                                        Console logging level.

                                        -
                                        LogLevel.Error
-
                                        - -
                                        showSwfDownload?: boolean

                                        If set to true, the context menu has an option to download -the SWF.

                                        -
                                        false
-
                                        - -
                                        contextMenu?: boolean | ContextMenu

                                        Whether or not to show a context menu when right-clicking -a Ruffle instance.

                                        -
                                        ContextMenu.On
-
                                        - -
                                        preloader?: boolean

                                        Whether or not to show a splash screen before the SWF has loaded with Ruffle (backwards-compatibility).

                                        -
                                        true
-
                                        - -
                                        splashScreen?: boolean

                                        Whether or not to show a splash screen before the SWF has loaded with Ruffle.

                                        -
                                        true
-
                                        - -
                                        maxExecutionDuration?: Duration

                                        Maximum amount of time a script can take before scripting -is disabled.

                                        -
                                        15
-
                                        - -
                                        base?: string | null

                                        Specifies the base directory or URL used to resolve all relative path statements in the SWF file. -null means the current directory.

                                        -
                                        null
-
                                        - -
                                        menu?: boolean

                                        If set to true, the built-in context menu items are visible

                                        -

                                        This is equivalent to Stage.showMenu.

                                        -
                                        true
-
                                        - -
                                        salign?: string

                                        This is equivalent to Stage.align.

                                        -
                                        ""
-
                                        - -
                                        fullScreenAspectRatio?: string

                                        Controls orientation on mobile in fullscreen mode.

                                        -

                                        This is equivalent to the AIR-only method Stage.setAspectRatio.

                                        -
                                        ""
-
                                        - -
                                        forceAlign?: boolean

                                        If set to true, movies are prevented from changing the stage alignment.

                                        -
                                        false
-
                                        - -
                                        quality?: string | null

                                        This is equivalent to Stage.quality.

                                        -
                                        null
-
                                        - -
                                        scale?: string

                                        This is equivalent to Stage.scaleMode.

                                        -
                                        "showAll"
-
                                        - -
                                        forceScale?: boolean

                                        If set to true, movies are prevented from changing the stage scale mode.

                                        -
                                        false
-
                                        - -
                                        allowFullscreen?: boolean

                                        If set to true, the Stage's displayState can be changed

                                        -
                                        false
-
                                        - -
                                        frameRate?: number | null

                                        Sets and locks the player's frame rate, overriding the movie's frame rate.

                                        -
                                        null
-
                                        - -
                                        wmode?: WindowMode

                                        The window mode of the Ruffle player.

                                        -

                                        This setting controls how the Ruffle container is layered and rendered with other content on the page.

                                        -
                                        WindowMode.Window
-
                                        - -
                                        playerVersion?: number | null

                                        The emulated version of the player.

                                        -

                                        This controls the version that is reported to the movie. -null means latest version.

                                        -
                                        null
-
                                        - -
                                        preferredRenderer?: RenderBackend | null

                                        The preferred render backend of the Ruffle player.

                                        -

                                        This option should only be used for testing; -the available backends may change in future releases. -By default, Ruffle chooses the most featureful backend supported by the user's system, -falling back to more basic backends if necessary. -The available values in order of default preference are: -"webgpu", "wgpu-webgl", "webgl", "canvas".

                                        -
                                        null
-
                                        - -
                                        publicPath?: string | null

                                        The URL at which Ruffle can load its extra files (i.e. .wasm).

                                        -
                                        null
-
                                        - -
                                        polyfills?: boolean

                                        Whether or not to enable polyfills on the page.

                                        -

                                        Polyfills will look for "legacy" flash content like <object> -and <embed> elements, and replace them with compatible -Ruffle elements.

                                        -
                                        true
-
                                        - -
                                        openUrlMode?: OpenURLMode

                                        The handling mode of links opening a new website.

                                        -
                                        OpenURLMode.Allow
-
                                        - -
                                        allowNetworking?: NetworkingAccessMode

                                        Which flash networking APIs may be accessed.

                                        -
                                        NetworkingAccessMode.All
-
                                        - -
                                        openInNewTab?: ((swf: URL) => void) | null

                                        A function to call for opening content in a new tab.

                                        -

                                        This is only used if the content cannot be loaded due to CORS, -and the Extension version of Ruffle will override this to provide a local player.

                                        -
                                        null
-
                                        - -
                                        socketProxy?: SocketProxy[]

                                        An array of SocketProxy objects.

                                        -

                                        When a SWF tries to establish a Socket connection, Ruffle will search for -a matching SocketProxy object in this array and use it to establish a WebSocket connection, -through which all communication is tunneled through.

                                        -

                                        When none are found, Ruffle will fail the connection gracefully. -When multiple matching SocketProxy objects exist, the first one is used.

                                        -
                                        []
-
                                        - -
                                        fontSources?: string[]

                                        An array of font URLs to eagerly load and provide to Ruffle.

                                        -

                                        These will be fetched by the browser as part of the loading of Flash content, which may slow down load times.

                                        -

                                        Currently only SWFs are supported, and each font embedded within that SWF will be used as device font by Flash content.

                                        -

                                        If any URL fails to load (either it's an invalid file, or a network error occurs), Ruffle will log an error but continue without it.

                                        -
                                        []
-
                                        - -
                                        defaultFonts?: DefaultFonts

                                        The font names to use for each "default" Flash device font.

                                        -
                                        {}
-
                                        - -
                                        credentialAllowList?: string[]

                                        An array of origins that credentials may be sent to. -Credentials are cookies, authorization headers, or TLS client certificates.

                                        -

                                        Entries should include the protocol and host, for example https://example.org or http://subdomain.example.org.

                                        -

                                        Cookies will always be sent to the same origin as the page the content was loaded on. -If you configure this to send cookies to an origin but that origin does not configure CORS to allow it, -then requests will start failing due to CORS. -See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.

                                        -

                                        This directly corresponds to https://developer.mozilla.org/en-US/docs/Web/API/fetch#credentials -Every request will be same-origin unless specified here, in which case it will be include.

                                        -
                                        []
-
                                        - -
                                        playerRuntime?: PlayerRuntime

                                        The player runtime to emulate

                                        -

                                        This allows you to emulate Adobe AIR or Adobe Flash Player.

                                        -
                                        gamepadButtonMapping?: Partial<Record<GamepadButton, number>>

                                        An object mapping gamepad button names to ActionScript key codes.

                                        -

                                        With the appropriate mapping pressing a button on the gamepad will look like the corresponding key press to the loaded SWF. -This can be used for adding gamepad support to games that don't support it otherwise.

                                        -

                                        An example config for mapping the D-pad to the arrow keys would look like this: -{ "dpad-up": 38, "dpad-down": 40, "dpad-left": 37, "dpad-right": 39, }

                                        -
                                        {}
-
                                        - -
                                        urlRewriteRules?: [string | RegExp, string][]

                                        A set of rules that rewrite URLs in both network requests and links.

                                        -

                                        They are always scanned in order, and the first one that matches is used. -A rule either matches using a RegExp (in which case the replacement may use $...), -or a string (in which case the match and the replacement are always exact).

                                        -

                                        They are useful when a SWF uses an obsolete URL, in which case -you can rewrite it to something else that works.

                                        -
                                        scrollingBehavior?: ScrollingBehavior

                                        Set the scrolling behavior, i.e. how scrolling Flash content affects the web page.

                                        -

                                        The original behavior in Flash Player differed across versions, browsers, and wmode settings.

                                        -
                                        ScrollingBehavior.Smart
-
                                        - -

                                        Settings

                                        Member Visibility

                                        On This Page

                                        Properties
                                        diff --git a/master/interfaces/Config.DataLoadOptions.html b/master/interfaces/Config.DataLoadOptions.html deleted file mode 100644 index 2141dfb63..000000000 --- a/master/interfaces/Config.DataLoadOptions.html +++ /dev/null @@ -1,282 +0,0 @@ -DataLoadOptions | ruffle-core
                                        ruffle-core
                                          Preparing search index...

                                          Interface DataLoadOptions

                                          Options to load a movie by a data stream.

                                          -
                                          interface DataLoadOptions {
                                              data: ArrayLike<number> | ArrayBuffer;
                                              swfFileName?: string;
                                              allowScriptAccess?: boolean;
                                              parameters?: string | URLSearchParams | Record<string, string> | null;
                                              autoplay?: AutoPlay;
                                              backgroundColor?: string | null;
                                              letterbox?: Letterbox;
                                              unmuteOverlay?: UnmuteOverlay;
                                              upgradeToHttps?: boolean;
                                              compatibilityRules?: boolean;
                                              favorFlash?: boolean;
                                              warnOnUnsupportedContent?: boolean;
                                              logLevel?: LogLevel;
                                              showSwfDownload?: boolean;
                                              contextMenu?: boolean | ContextMenu;
                                              preloader?: boolean;
                                              splashScreen?: boolean;
                                              maxExecutionDuration?: Duration;
                                              base?: string | null;
                                              menu?: boolean;
                                              salign?: string;
                                              fullScreenAspectRatio?: string;
                                              forceAlign?: boolean;
                                              quality?: string | null;
                                              scale?: string;
                                              forceScale?: boolean;
                                              allowFullscreen?: boolean;
                                              frameRate?: number | null;
                                              wmode?: WindowMode;
                                              playerVersion?: number | null;
                                              preferredRenderer?: RenderBackend | null;
                                              publicPath?: string | null;
                                              polyfills?: boolean;
                                              openUrlMode?: OpenURLMode;
                                              allowNetworking?: NetworkingAccessMode;
                                              openInNewTab?: ((swf: URL) => void) | null;
                                              socketProxy?: SocketProxy[];
                                              fontSources?: string[];
                                              defaultFonts?: DefaultFonts;
                                              credentialAllowList?: string[];
                                              playerRuntime?: PlayerRuntime;
                                              gamepadButtonMapping?: Partial<Record<GamepadButton, number>>;
                                              urlRewriteRules?: [string | RegExp, string][];
                                              scrollingBehavior?: ScrollingBehavior;
                                          }

                                          Hierarchy (View Summary)

                                          Index

                                          Properties

                                          data -swfFileName? -allowScriptAccess? -parameters? -autoplay? -backgroundColor? -letterbox? -unmuteOverlay? -upgradeToHttps? -compatibilityRules? -favorFlash? -warnOnUnsupportedContent? -logLevel? -showSwfDownload? -contextMenu? -preloader? -splashScreen? -maxExecutionDuration? -base? -menu? -salign? -fullScreenAspectRatio? -forceAlign? -quality? -scale? -forceScale? -allowFullscreen? -frameRate? -wmode? -playerVersion? -preferredRenderer? -publicPath? -polyfills? -openUrlMode? -allowNetworking? -openInNewTab? -socketProxy? -fontSources? -defaultFonts? -credentialAllowList? -playerRuntime? -gamepadButtonMapping? -urlRewriteRules? -scrollingBehavior? -

                                          Properties

                                          data: ArrayLike<number> | ArrayBuffer

                                          The data to load a movie from.

                                          -
                                          swfFileName?: string

                                          The filename of the SWF movie to provide to ActionScript.

                                          -
                                          "movie.swf"
-
                                          - -
                                          allowScriptAccess?: boolean

                                          If set to true, the movie is allowed to interact with the page through -JavaScript, using a flash concept called ExternalInterface.

                                          -

                                          This should only be enabled for movies you trust.

                                          -
                                          false
-
                                          - -
                                          parameters?: string | URLSearchParams | Record<string, string> | null

                                          Also known as "flashvars" - these are values that may be passed to -and loaded by the movie.

                                          -

                                          If a URL if specified when loading the movie, some parameters will -be extracted by the query portion of that URL and then overwritten -by any explicitly set here.

                                          -
                                          {}
-
                                          - -
                                          autoplay?: AutoPlay

                                          Controls the auto-play behaviour of Ruffle.

                                          -
                                          AutoPlay.Auto
-
                                          - -
                                          backgroundColor?: string | null

                                          Controls the background color of the player. -Must be an HTML color (e.g. "#FFFFFF"). CSS colors are not allowed. -null uses the background color of the SWF file.

                                          -
                                          null
-
                                          - -
                                          letterbox?: Letterbox

                                          Controls letterbox behavior when the Flash container size does not -match the movie size.

                                          -
                                          Letterbox.Fullscreen
-
                                          - -
                                          unmuteOverlay?: UnmuteOverlay

                                          Controls the visibility of the unmute overlay when the player -is started muted.

                                          -
                                          UnmuteOverlay.Visible
-
                                          - -
                                          upgradeToHttps?: boolean

                                          Whether or not to auto-upgrade all embedded URLs to https.

                                          -

                                          Flash content that embeds http urls will be blocked from -accessing those urls by the browser when Ruffle is loaded -in a https context. Set to true to automatically change -http:// to https:// for all embedded URLs when Ruffle is -loaded in an https context.

                                          -
                                          true
-
                                          - -
                                          compatibilityRules?: boolean

                                          Enable (true) or disable (false) Ruffle's built in compatibility rules.

                                          -

                                          These are rules that may make some content work by deliberately changing -behaviour, for example by rewriting requests or spoofing SWF urls if they -rely on websites that no longer exist.

                                          -
                                          true
-
                                          - -
                                          favorFlash?: boolean

                                          Favor using the real Adobe Flash Player over Ruffle if the browser supports it.

                                          -
                                          true
-
                                          - -
                                          warnOnUnsupportedContent?: boolean

                                          This is no longer used and does not affect anything. -It is only kept for backwards compatibility.

                                          -

                                          Previously: -"Whether or not to display an overlay with a warning when -loading a movie with unsupported content."

                                          -
                                          true
-
                                          - -
                                          logLevel?: LogLevel

                                          Console logging level.

                                          -
                                          LogLevel.Error
-
                                          - -
                                          showSwfDownload?: boolean

                                          If set to true, the context menu has an option to download -the SWF.

                                          -
                                          false
-
                                          - -
                                          contextMenu?: boolean | ContextMenu

                                          Whether or not to show a context menu when right-clicking -a Ruffle instance.

                                          -
                                          ContextMenu.On
-
                                          - -
                                          preloader?: boolean

                                          Whether or not to show a splash screen before the SWF has loaded with Ruffle (backwards-compatibility).

                                          -
                                          true
-
                                          - -
                                          splashScreen?: boolean

                                          Whether or not to show a splash screen before the SWF has loaded with Ruffle.

                                          -
                                          true
-
                                          - -
                                          maxExecutionDuration?: Duration

                                          Maximum amount of time a script can take before scripting -is disabled.

                                          -
                                          15
-
                                          - -
                                          base?: string | null

                                          Specifies the base directory or URL used to resolve all relative path statements in the SWF file. -null means the current directory.

                                          -
                                          null
-
                                          - -
                                          menu?: boolean

                                          If set to true, the built-in context menu items are visible

                                          -

                                          This is equivalent to Stage.showMenu.

                                          -
                                          true
-
                                          - -
                                          salign?: string

                                          This is equivalent to Stage.align.

                                          -
                                          ""
-
                                          - -
                                          fullScreenAspectRatio?: string

                                          Controls orientation on mobile in fullscreen mode.

                                          -

                                          This is equivalent to the AIR-only method Stage.setAspectRatio.

                                          -
                                          ""
-
                                          - -
                                          forceAlign?: boolean

                                          If set to true, movies are prevented from changing the stage alignment.

                                          -
                                          false
-
                                          - -
                                          quality?: string | null

                                          This is equivalent to Stage.quality.

                                          -
                                          null
-
                                          - -
                                          scale?: string

                                          This is equivalent to Stage.scaleMode.

                                          -
                                          "showAll"
-
                                          - -
                                          forceScale?: boolean

                                          If set to true, movies are prevented from changing the stage scale mode.

                                          -
                                          false
-
                                          - -
                                          allowFullscreen?: boolean

                                          If set to true, the Stage's displayState can be changed

                                          -
                                          false
-
                                          - -
                                          frameRate?: number | null

                                          Sets and locks the player's frame rate, overriding the movie's frame rate.

                                          -
                                          null
-
                                          - -
                                          wmode?: WindowMode

                                          The window mode of the Ruffle player.

                                          -

                                          This setting controls how the Ruffle container is layered and rendered with other content on the page.

                                          -
                                          WindowMode.Window
-
                                          - -
                                          playerVersion?: number | null

                                          The emulated version of the player.

                                          -

                                          This controls the version that is reported to the movie. -null means latest version.

                                          -
                                          null
-
                                          - -
                                          preferredRenderer?: RenderBackend | null

                                          The preferred render backend of the Ruffle player.

                                          -

                                          This option should only be used for testing; -the available backends may change in future releases. -By default, Ruffle chooses the most featureful backend supported by the user's system, -falling back to more basic backends if necessary. -The available values in order of default preference are: -"webgpu", "wgpu-webgl", "webgl", "canvas".

                                          -
                                          null
-
                                          - -
                                          publicPath?: string | null

                                          The URL at which Ruffle can load its extra files (i.e. .wasm).

                                          -
                                          null
-
                                          - -
                                          polyfills?: boolean

                                          Whether or not to enable polyfills on the page.

                                          -

                                          Polyfills will look for "legacy" flash content like <object> -and <embed> elements, and replace them with compatible -Ruffle elements.

                                          -
                                          true
-
                                          - -
                                          openUrlMode?: OpenURLMode

                                          The handling mode of links opening a new website.

                                          -
                                          OpenURLMode.Allow
-
                                          - -
                                          allowNetworking?: NetworkingAccessMode

                                          Which flash networking APIs may be accessed.

                                          -
                                          NetworkingAccessMode.All
-
                                          - -
                                          openInNewTab?: ((swf: URL) => void) | null

                                          A function to call for opening content in a new tab.

                                          -

                                          This is only used if the content cannot be loaded due to CORS, -and the Extension version of Ruffle will override this to provide a local player.

                                          -
                                          null
-
                                          - -
                                          socketProxy?: SocketProxy[]

                                          An array of SocketProxy objects.

                                          -

                                          When a SWF tries to establish a Socket connection, Ruffle will search for -a matching SocketProxy object in this array and use it to establish a WebSocket connection, -through which all communication is tunneled through.

                                          -

                                          When none are found, Ruffle will fail the connection gracefully. -When multiple matching SocketProxy objects exist, the first one is used.

                                          -
                                          []
-
                                          - -
                                          fontSources?: string[]

                                          An array of font URLs to eagerly load and provide to Ruffle.

                                          -

                                          These will be fetched by the browser as part of the loading of Flash content, which may slow down load times.

                                          -

                                          Currently only SWFs are supported, and each font embedded within that SWF will be used as device font by Flash content.

                                          -

                                          If any URL fails to load (either it's an invalid file, or a network error occurs), Ruffle will log an error but continue without it.

                                          -
                                          []
-
                                          - -
                                          defaultFonts?: DefaultFonts

                                          The font names to use for each "default" Flash device font.

                                          -
                                          {}
-
                                          - -
                                          credentialAllowList?: string[]

                                          An array of origins that credentials may be sent to. -Credentials are cookies, authorization headers, or TLS client certificates.

                                          -

                                          Entries should include the protocol and host, for example https://example.org or http://subdomain.example.org.

                                          -

                                          Cookies will always be sent to the same origin as the page the content was loaded on. -If you configure this to send cookies to an origin but that origin does not configure CORS to allow it, -then requests will start failing due to CORS. -See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.

                                          -

                                          This directly corresponds to https://developer.mozilla.org/en-US/docs/Web/API/fetch#credentials -Every request will be same-origin unless specified here, in which case it will be include.

                                          -
                                          []
-
                                          - -
                                          playerRuntime?: PlayerRuntime

                                          The player runtime to emulate

                                          -

                                          This allows you to emulate Adobe AIR or Adobe Flash Player.

                                          -
                                          gamepadButtonMapping?: Partial<Record<GamepadButton, number>>

                                          An object mapping gamepad button names to ActionScript key codes.

                                          -

                                          With the appropriate mapping pressing a button on the gamepad will look like the corresponding key press to the loaded SWF. -This can be used for adding gamepad support to games that don't support it otherwise.

                                          -

                                          An example config for mapping the D-pad to the arrow keys would look like this: -{ "dpad-up": 38, "dpad-down": 40, "dpad-left": 37, "dpad-right": 39, }

                                          -
                                          {}
-
                                          - -
                                          urlRewriteRules?: [string | RegExp, string][]

                                          A set of rules that rewrite URLs in both network requests and links.

                                          -

                                          They are always scanned in order, and the first one that matches is used. -A rule either matches using a RegExp (in which case the replacement may use $...), -or a string (in which case the match and the replacement are always exact).

                                          -

                                          They are useful when a SWF uses an obsolete URL, in which case -you can rewrite it to something else that works.

                                          -
                                          scrollingBehavior?: ScrollingBehavior

                                          Set the scrolling behavior, i.e. how scrolling Flash content affects the web page.

                                          -

                                          The original behavior in Flash Player differed across versions, browsers, and wmode settings.

                                          -
                                          ScrollingBehavior.Smart
-
                                          - -

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Properties
                                          diff --git a/master/interfaces/Config.DefaultFonts.html b/master/interfaces/Config.DefaultFonts.html deleted file mode 100644 index cc8072f56..000000000 --- a/master/interfaces/Config.DefaultFonts.html +++ /dev/null @@ -1,16 +0,0 @@ -DefaultFonts | ruffle-core
                                          ruffle-core
                                            Preparing search index...

                                            Interface DefaultFonts

                                            Defines the names of the fonts to use for each "default" Flash device font.

                                            -

                                            The name of each font provided will be used, in priority order.

                                            -

                                            For example, defining sans: ["Helvetica", "Arial"] would use Helvetica if present, before trying Arial.

                                            -
                                            interface DefaultFonts {
                                                sans?: string[];
                                                serif?: string[];
                                                typewriter?: string[];
                                                japaneseGothic?: string[];
                                                japaneseGothicMono?: string[];
                                                japaneseMincho?: string[];
                                            }
                                            Index

                                            Properties

                                            sans? -serif? -typewriter? -japaneseGothic? -japaneseGothicMono? -japaneseMincho? -

                                            Properties

                                            sans?: string[]

                                            _sans, a Sans-Serif font (similar to Helvetica or Arial)

                                            -
                                            serif?: string[]

                                            _serif, a Serif font (similar to Times Roman)

                                            -
                                            typewriter?: string[]

                                            _typewriter, a Monospace font (similar to Courier)

                                            -
                                            japaneseGothic?: string[]

                                            _ゴシック, a Japanese Gothic font

                                            -
                                            japaneseGothicMono?: string[]

                                            _等幅, a Japanese Gothic Mono font

                                            -
                                            japaneseMincho?: string[]

                                            _明朝, a Japanese Mincho font

                                            -

                                            Settings

                                            Member Visibility

                                            On This Page

                                            Properties
                                            diff --git a/master/interfaces/Config.ObsoleteDuration.html b/master/interfaces/Config.ObsoleteDuration.html deleted file mode 100644 index 36717ede8..000000000 --- a/master/interfaces/Config.ObsoleteDuration.html +++ /dev/null @@ -1,5 +0,0 @@ -ObsoleteDuration | ruffle-core
                                            ruffle-core
                                              Preparing search index...

                                              Interface ObsoleteDuration

                                              Deprecated duration type, use SecsDuration instead. -Based on https://doc.rust-lang.org/stable/std/time/struct.Duration.html#method.new .

                                              -
                                              interface ObsoleteDuration {
                                                  secs: number;
                                                  nanos: number;
                                              }
                                              Index

                                              Properties

                                              secs -nanos -

                                              Properties

                                              secs: number
                                              nanos: number

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Properties
                                              diff --git a/master/interfaces/Config.SocketProxy.html b/master/interfaces/Config.SocketProxy.html deleted file mode 100644 index adbc761ae..000000000 --- a/master/interfaces/Config.SocketProxy.html +++ /dev/null @@ -1,8 +0,0 @@ -SocketProxy | ruffle-core
                                              ruffle-core
                                                Preparing search index...

                                                Interface SocketProxy

                                                Represents a host, port and proxyUrl. Used when a SWF file tries to use a Socket.

                                                -
                                                interface SocketProxy {
                                                    host: string;
                                                    port: number;
                                                    proxyUrl: string;
                                                }
                                                Index

                                                Properties

                                                host -port -proxyUrl -

                                                Properties

                                                host: string

                                                Host used by the SWF.

                                                -
                                                port: number

                                                Port used by the SWF.

                                                -
                                                proxyUrl: string

                                                The proxy URL to use when SWF file tries to connect to the specified host and port.

                                                -

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Properties
                                                diff --git a/master/interfaces/Config.URLLoadOptions.html b/master/interfaces/Config.URLLoadOptions.html deleted file mode 100644 index ec7b75b0e..000000000 --- a/master/interfaces/Config.URLLoadOptions.html +++ /dev/null @@ -1,279 +0,0 @@ -URLLoadOptions | ruffle-core
                                                ruffle-core
                                                  Preparing search index...

                                                  Interface URLLoadOptions

                                                  Options to load a movie by URL.

                                                  -
                                                  interface URLLoadOptions {
                                                      url: string;
                                                      allowScriptAccess?: boolean;
                                                      parameters?: string | URLSearchParams | Record<string, string> | null;
                                                      autoplay?: AutoPlay;
                                                      backgroundColor?: string | null;
                                                      letterbox?: Letterbox;
                                                      unmuteOverlay?: UnmuteOverlay;
                                                      upgradeToHttps?: boolean;
                                                      compatibilityRules?: boolean;
                                                      favorFlash?: boolean;
                                                      warnOnUnsupportedContent?: boolean;
                                                      logLevel?: LogLevel;
                                                      showSwfDownload?: boolean;
                                                      contextMenu?: boolean | ContextMenu;
                                                      preloader?: boolean;
                                                      splashScreen?: boolean;
                                                      maxExecutionDuration?: Duration;
                                                      base?: string | null;
                                                      menu?: boolean;
                                                      salign?: string;
                                                      fullScreenAspectRatio?: string;
                                                      forceAlign?: boolean;
                                                      quality?: string | null;
                                                      scale?: string;
                                                      forceScale?: boolean;
                                                      allowFullscreen?: boolean;
                                                      frameRate?: number | null;
                                                      wmode?: WindowMode;
                                                      playerVersion?: number | null;
                                                      preferredRenderer?: RenderBackend | null;
                                                      publicPath?: string | null;
                                                      polyfills?: boolean;
                                                      openUrlMode?: OpenURLMode;
                                                      allowNetworking?: NetworkingAccessMode;
                                                      openInNewTab?: ((swf: URL) => void) | null;
                                                      socketProxy?: SocketProxy[];
                                                      fontSources?: string[];
                                                      defaultFonts?: DefaultFonts;
                                                      credentialAllowList?: string[];
                                                      playerRuntime?: PlayerRuntime;
                                                      gamepadButtonMapping?: Partial<Record<GamepadButton, number>>;
                                                      urlRewriteRules?: [string | RegExp, string][];
                                                      scrollingBehavior?: ScrollingBehavior;
                                                  }

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Properties

                                                  url -allowScriptAccess? -parameters? -autoplay? -backgroundColor? -letterbox? -unmuteOverlay? -upgradeToHttps? -compatibilityRules? -favorFlash? -warnOnUnsupportedContent? -logLevel? -showSwfDownload? -contextMenu? -preloader? -splashScreen? -maxExecutionDuration? -base? -menu? -salign? -fullScreenAspectRatio? -forceAlign? -quality? -scale? -forceScale? -allowFullscreen? -frameRate? -wmode? -playerVersion? -preferredRenderer? -publicPath? -polyfills? -openUrlMode? -allowNetworking? -openInNewTab? -socketProxy? -fontSources? -defaultFonts? -credentialAllowList? -playerRuntime? -gamepadButtonMapping? -urlRewriteRules? -scrollingBehavior? -

                                                  Properties

                                                  url: string

                                                  The URL to load a movie from.

                                                  -

                                                  If there is a query portion of this URL, then default parameters -will be extracted from that.

                                                  -
                                                  allowScriptAccess?: boolean

                                                  If set to true, the movie is allowed to interact with the page through -JavaScript, using a flash concept called ExternalInterface.

                                                  -

                                                  This should only be enabled for movies you trust.

                                                  -
                                                  false
-
                                                  - -
                                                  parameters?: string | URLSearchParams | Record<string, string> | null

                                                  Also known as "flashvars" - these are values that may be passed to -and loaded by the movie.

                                                  -

                                                  If a URL if specified when loading the movie, some parameters will -be extracted by the query portion of that URL and then overwritten -by any explicitly set here.

                                                  -
                                                  {}
-
                                                  - -
                                                  autoplay?: AutoPlay

                                                  Controls the auto-play behaviour of Ruffle.

                                                  -
                                                  AutoPlay.Auto
-
                                                  - -
                                                  backgroundColor?: string | null

                                                  Controls the background color of the player. -Must be an HTML color (e.g. "#FFFFFF"). CSS colors are not allowed. -null uses the background color of the SWF file.

                                                  -
                                                  null
-
                                                  - -
                                                  letterbox?: Letterbox

                                                  Controls letterbox behavior when the Flash container size does not -match the movie size.

                                                  -
                                                  Letterbox.Fullscreen
-
                                                  - -
                                                  unmuteOverlay?: UnmuteOverlay

                                                  Controls the visibility of the unmute overlay when the player -is started muted.

                                                  -
                                                  UnmuteOverlay.Visible
-
                                                  - -
                                                  upgradeToHttps?: boolean

                                                  Whether or not to auto-upgrade all embedded URLs to https.

                                                  -

                                                  Flash content that embeds http urls will be blocked from -accessing those urls by the browser when Ruffle is loaded -in a https context. Set to true to automatically change -http:// to https:// for all embedded URLs when Ruffle is -loaded in an https context.

                                                  -
                                                  true
-
                                                  - -
                                                  compatibilityRules?: boolean

                                                  Enable (true) or disable (false) Ruffle's built in compatibility rules.

                                                  -

                                                  These are rules that may make some content work by deliberately changing -behaviour, for example by rewriting requests or spoofing SWF urls if they -rely on websites that no longer exist.

                                                  -
                                                  true
-
                                                  - -
                                                  favorFlash?: boolean

                                                  Favor using the real Adobe Flash Player over Ruffle if the browser supports it.

                                                  -
                                                  true
-
                                                  - -
                                                  warnOnUnsupportedContent?: boolean

                                                  This is no longer used and does not affect anything. -It is only kept for backwards compatibility.

                                                  -

                                                  Previously: -"Whether or not to display an overlay with a warning when -loading a movie with unsupported content."

                                                  -
                                                  true
-
                                                  - -
                                                  logLevel?: LogLevel

                                                  Console logging level.

                                                  -
                                                  LogLevel.Error
-
                                                  - -
                                                  showSwfDownload?: boolean

                                                  If set to true, the context menu has an option to download -the SWF.

                                                  -
                                                  false
-
                                                  - -
                                                  contextMenu?: boolean | ContextMenu

                                                  Whether or not to show a context menu when right-clicking -a Ruffle instance.

                                                  -
                                                  ContextMenu.On
-
                                                  - -
                                                  preloader?: boolean

                                                  Whether or not to show a splash screen before the SWF has loaded with Ruffle (backwards-compatibility).

                                                  -
                                                  true
-
                                                  - -
                                                  splashScreen?: boolean

                                                  Whether or not to show a splash screen before the SWF has loaded with Ruffle.

                                                  -
                                                  true
-
                                                  - -
                                                  maxExecutionDuration?: Duration

                                                  Maximum amount of time a script can take before scripting -is disabled.

                                                  -
                                                  15
-
                                                  - -
                                                  base?: string | null

                                                  Specifies the base directory or URL used to resolve all relative path statements in the SWF file. -null means the current directory.

                                                  -
                                                  null
-
                                                  - -
                                                  menu?: boolean

                                                  If set to true, the built-in context menu items are visible

                                                  -

                                                  This is equivalent to Stage.showMenu.

                                                  -
                                                  true
-
                                                  - -
                                                  salign?: string

                                                  This is equivalent to Stage.align.

                                                  -
                                                  ""
-
                                                  - -
                                                  fullScreenAspectRatio?: string

                                                  Controls orientation on mobile in fullscreen mode.

                                                  -

                                                  This is equivalent to the AIR-only method Stage.setAspectRatio.

                                                  -
                                                  ""
-
                                                  - -
                                                  forceAlign?: boolean

                                                  If set to true, movies are prevented from changing the stage alignment.

                                                  -
                                                  false
-
                                                  - -
                                                  quality?: string | null

                                                  This is equivalent to Stage.quality.

                                                  -
                                                  null
-
                                                  - -
                                                  scale?: string

                                                  This is equivalent to Stage.scaleMode.

                                                  -
                                                  "showAll"
-
                                                  - -
                                                  forceScale?: boolean

                                                  If set to true, movies are prevented from changing the stage scale mode.

                                                  -
                                                  false
-
                                                  - -
                                                  allowFullscreen?: boolean

                                                  If set to true, the Stage's displayState can be changed

                                                  -
                                                  false
-
                                                  - -
                                                  frameRate?: number | null

                                                  Sets and locks the player's frame rate, overriding the movie's frame rate.

                                                  -
                                                  null
-
                                                  - -
                                                  wmode?: WindowMode

                                                  The window mode of the Ruffle player.

                                                  -

                                                  This setting controls how the Ruffle container is layered and rendered with other content on the page.

                                                  -
                                                  WindowMode.Window
-
                                                  - -
                                                  playerVersion?: number | null

                                                  The emulated version of the player.

                                                  -

                                                  This controls the version that is reported to the movie. -null means latest version.

                                                  -
                                                  null
-
                                                  - -
                                                  preferredRenderer?: RenderBackend | null

                                                  The preferred render backend of the Ruffle player.

                                                  -

                                                  This option should only be used for testing; -the available backends may change in future releases. -By default, Ruffle chooses the most featureful backend supported by the user's system, -falling back to more basic backends if necessary. -The available values in order of default preference are: -"webgpu", "wgpu-webgl", "webgl", "canvas".

                                                  -
                                                  null
-
                                                  - -
                                                  publicPath?: string | null

                                                  The URL at which Ruffle can load its extra files (i.e. .wasm).

                                                  -
                                                  null
-
                                                  - -
                                                  polyfills?: boolean

                                                  Whether or not to enable polyfills on the page.

                                                  -

                                                  Polyfills will look for "legacy" flash content like <object> -and <embed> elements, and replace them with compatible -Ruffle elements.

                                                  -
                                                  true
-
                                                  - -
                                                  openUrlMode?: OpenURLMode

                                                  The handling mode of links opening a new website.

                                                  -
                                                  OpenURLMode.Allow
-
                                                  - -
                                                  allowNetworking?: NetworkingAccessMode

                                                  Which flash networking APIs may be accessed.

                                                  -
                                                  NetworkingAccessMode.All
-
                                                  - -
                                                  openInNewTab?: ((swf: URL) => void) | null

                                                  A function to call for opening content in a new tab.

                                                  -

                                                  This is only used if the content cannot be loaded due to CORS, -and the Extension version of Ruffle will override this to provide a local player.

                                                  -
                                                  null
-
                                                  - -
                                                  socketProxy?: SocketProxy[]

                                                  An array of SocketProxy objects.

                                                  -

                                                  When a SWF tries to establish a Socket connection, Ruffle will search for -a matching SocketProxy object in this array and use it to establish a WebSocket connection, -through which all communication is tunneled through.

                                                  -

                                                  When none are found, Ruffle will fail the connection gracefully. -When multiple matching SocketProxy objects exist, the first one is used.

                                                  -
                                                  []
-
                                                  - -
                                                  fontSources?: string[]

                                                  An array of font URLs to eagerly load and provide to Ruffle.

                                                  -

                                                  These will be fetched by the browser as part of the loading of Flash content, which may slow down load times.

                                                  -

                                                  Currently only SWFs are supported, and each font embedded within that SWF will be used as device font by Flash content.

                                                  -

                                                  If any URL fails to load (either it's an invalid file, or a network error occurs), Ruffle will log an error but continue without it.

                                                  -
                                                  []
-
                                                  - -
                                                  defaultFonts?: DefaultFonts

                                                  The font names to use for each "default" Flash device font.

                                                  -
                                                  {}
-
                                                  - -
                                                  credentialAllowList?: string[]

                                                  An array of origins that credentials may be sent to. -Credentials are cookies, authorization headers, or TLS client certificates.

                                                  -

                                                  Entries should include the protocol and host, for example https://example.org or http://subdomain.example.org.

                                                  -

                                                  Cookies will always be sent to the same origin as the page the content was loaded on. -If you configure this to send cookies to an origin but that origin does not configure CORS to allow it, -then requests will start failing due to CORS. -See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.

                                                  -

                                                  This directly corresponds to https://developer.mozilla.org/en-US/docs/Web/API/fetch#credentials -Every request will be same-origin unless specified here, in which case it will be include.

                                                  -
                                                  []
-
                                                  - -
                                                  playerRuntime?: PlayerRuntime

                                                  The player runtime to emulate

                                                  -

                                                  This allows you to emulate Adobe AIR or Adobe Flash Player.

                                                  -
                                                  gamepadButtonMapping?: Partial<Record<GamepadButton, number>>

                                                  An object mapping gamepad button names to ActionScript key codes.

                                                  -

                                                  With the appropriate mapping pressing a button on the gamepad will look like the corresponding key press to the loaded SWF. -This can be used for adding gamepad support to games that don't support it otherwise.

                                                  -

                                                  An example config for mapping the D-pad to the arrow keys would look like this: -{ "dpad-up": 38, "dpad-down": 40, "dpad-left": 37, "dpad-right": 39, }

                                                  -
                                                  {}
-
                                                  - -
                                                  urlRewriteRules?: [string | RegExp, string][]

                                                  A set of rules that rewrite URLs in both network requests and links.

                                                  -

                                                  They are always scanned in order, and the first one that matches is used. -A rule either matches using a RegExp (in which case the replacement may use $...), -or a string (in which case the match and the replacement are always exact).

                                                  -

                                                  They are useful when a SWF uses an obsolete URL, in which case -you can rewrite it to something else that works.

                                                  -
                                                  scrollingBehavior?: ScrollingBehavior

                                                  Set the scrolling behavior, i.e. how scrolling Flash content affects the web page.

                                                  -

                                                  The original behavior in Flash Player differed across versions, browsers, and wmode settings.

                                                  -
                                                  ScrollingBehavior.Smart
-
                                                  - -

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Properties
                                                  diff --git a/master/interfaces/Player.FlashAPI.html b/master/interfaces/Player.FlashAPI.html deleted file mode 100644 index 7074653b5..000000000 --- a/master/interfaces/Player.FlashAPI.html +++ /dev/null @@ -1,10 +0,0 @@ -FlashAPI | ruffle-core
                                                  ruffle-core
                                                    Preparing search index...

                                                    Interface FlashAPI

                                                    These are properties and methods that Flash added to its <embed>/<object> tags. -These don't seem to be documented in full anywhere, and Ruffle adds them as we encounter some. -You are discouraged from using these, and they exist only to support legacy websites from decades ago.

                                                    -

                                                    Extra methods or properties may appear at any time, due to ExternalInterface.addCallback(). -It may even overwrite existing methods or properties.

                                                    -
                                                    interface FlashAPI {
                                                        PercentLoaded(): number;
                                                    }

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Methods

                                                    PercentLoaded -

                                                    Methods

                                                    • Returns the movies loaded process, in a percent from 0 to 100. -Ruffle may just return 0 or 100.

                                                      -

                                                      Returns number

                                                      a value from 0 to 100, inclusive.

                                                      -

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    Methods
                                                    diff --git a/master/interfaces/Player.LegacyRuffleAPI.html b/master/interfaces/Player.LegacyRuffleAPI.html deleted file mode 100644 index 049574893..000000000 --- a/master/interfaces/Player.LegacyRuffleAPI.html +++ /dev/null @@ -1,155 +0,0 @@ -LegacyRuffleAPI | ruffle-core
                                                    ruffle-core
                                                      Preparing search index...

                                                      Interface LegacyRuffleAPI

                                                      Legacy interface to the Ruffle API.

                                                      -

                                                      Please use ruffle() to access a versioned API. -Any of these methods or properties may be replaced by Flash and are not guaranteed to exist.

                                                      -
                                                      interface LegacyRuffleAPI {
                                                          onFSCommand: ((command: string, args: string) => void) | null;
                                                          config: object | URLLoadOptions | DataLoadOptions;
                                                          loadedConfig: URLLoadOptions | DataLoadOptions | null;
                                                          get readyState(): ReadyState;
                                                          get metadata(): MovieMetadata | null;
                                                          reload(): Promise<void>;
                                                          load(options: string | URLLoadOptions | DataLoadOptions): Promise<void>;
                                                          play(): void;
                                                          get isPlaying(): boolean;
                                                          get volume(): number;
                                                          set volume(value: number): void;
                                                          get fullscreenEnabled(): boolean;
                                                          get isFullscreen(): boolean;
                                                          setFullscreen(isFull: boolean): void;
                                                          enterFullscreen(): void;
                                                          exitFullscreen(): void;
                                                          pause(): void;
                                                          set traceObserver(observer: ((message: string) => void) | null): void;
                                                          downloadSwf(): Promise<void>;
                                                          displayMessage(message: string): void;
                                                      }

                                                      Hierarchy (View Summary)

                                                      Index

                                                      Properties

                                                      onFSCommand -config -loadedConfig -

                                                      Accessors

                                                      readyState -metadata -isPlaying -volume -fullscreenEnabled -isFullscreen -traceObserver -

                                                      Methods

                                                      reload -load -play -setFullscreen -enterFullscreen -exitFullscreen -pause -downloadSwf -displayMessage -

                                                      Properties

                                                      onFSCommand: ((command: string, args: string) => void) | null

                                                      Adds a handler for arbitrary "fs commands" from a movie in this player.

                                                      -

                                                      Type Declaration

                                                      • (command: string, args: string) => void
                                                          • (command: string, args: string): void

                                                          • Parameters

                                                            • command: string

                                                              An arbitrary name of a command.

                                                              -
                                                            • args: string

                                                              An arbitrary argument to the command.

                                                              -

                                                            Returns void

                                                      • null

                                                      If script access is allowed, a movie may communicate to the page through the ActionScript method fscommand(name, args).

                                                      -

                                                      The exact commands and their arguments are more or less arbitrary and up to the movie. -This is an incredibly deprecated way of communicating between Flash and JavaScript, -and was deprecated in favor of ExternalInterface in Flash Player 8 (2005).

                                                      -

                                                      Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.addFSCommandHandler, which supports multiple handlers.

                                                      -
                                                      config: object | URLLoadOptions | DataLoadOptions

                                                      Any configuration that should apply to this specific player. -This will be defaulted with any global configuration.

                                                      -

                                                      Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.config

                                                      -
                                                      loadedConfig: URLLoadOptions | DataLoadOptions | null

                                                      The effective config loaded with the last call to load(). -If no such call has been made, this will be null.

                                                      -

                                                      Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.loadedConfig

                                                      -

                                                      Accessors

                                                      • get metadata(): MovieMetadata | null

                                                        The metadata of the playing movie (such as movie width and height). -These are inherent properties stored in the SWF file and are not affected by runtime changes. -For example, metadata.width is the width of the SWF file, and not the width of the Ruffle player.

                                                        -

                                                        Returns MovieMetadata | null

                                                        The metadata of the movie, or null if the movie metadata has not yet loaded.

                                                        -

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.metadata

                                                        -
                                                      • get isPlaying(): boolean

                                                        Checks if this player is not suspended.

                                                        -

                                                        A suspended movie will not execute any frames, scripts or sounds. -This movie is considered inactive and will not wake up until resumed. -If no movie is loaded, this method will return true.

                                                        -

                                                        Returns boolean

                                                        True if this player is playing, false if it's paused or hasn't started yet.

                                                        -

                                                        This method was confusingly named and kept for legacy compatibility. -"Playing" in this context referred to "not being suspended", and not the Flash concept of playing/paused.

                                                        -

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.suspended (though inversed!)

                                                        -
                                                      • get volume(): number

                                                        Returns the master volume of the player.

                                                        -

                                                        The volume is linear and not adapted for logarithmic hearing.

                                                        -

                                                        Returns number

                                                        The volume. 1.0 is 100% volume.

                                                        -

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.volume

                                                        -
                                                      • set volume(value: number): void

                                                        Sets the master volume of the player.

                                                        -

                                                        The volume should be linear and not adapted for logarithmic hearing.

                                                        -

                                                        Parameters

                                                        • value: number

                                                          The volume. 1.0 is 100% volume.

                                                          -

                                                        Returns void

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.volume

                                                        -
                                                      • get isFullscreen(): boolean

                                                        Checks if this player is currently fullscreen inside the browser.

                                                        -

                                                        Returns boolean

                                                        True if it is fullscreen.

                                                        -

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.isFullscreen

                                                        -
                                                      • set traceObserver(observer: ((message: string) => void) | null): void

                                                        Sets a trace observer on this flash player.

                                                        -

                                                        The observer will be called, as a function, for each message that the playing movie will "trace" (output).

                                                        -

                                                        Parameters

                                                        • observer: ((message: string) => void) | null

                                                          The observer that will be called for each trace.

                                                          -

                                                        Returns void

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.traceObserver

                                                        -

                                                      Methods

                                                      • Reloads the player, as if you called load with the same config as the last time it was called.

                                                        -

                                                        If this player has never been loaded, this method will return an error.

                                                        -

                                                        Returns Promise<void>

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.reload

                                                        -

                                                      • Loads a specified movie into this player.

                                                        -

                                                        This will replace any existing movie that may be playing.

                                                        -

                                                        Parameters

                                                        • options: string | URLLoadOptions | DataLoadOptions

                                                          One of the following:

                                                          -
                                                            -
                                                          • A URL, passed as a string, which will load a URL with default options.
                                                            • -
                                                          • A URLLoadOptions object, to load a URL with options.
                                                            • -
                                                          • A DataLoadOptions object, to load data with options. -The options, if provided, must only contain values provided for this specific movie. -They must not contain any default values, since those would overwrite other configuration -settings with a lower priority (e.g. the general RufflePlayer config).
                                                            • -
                                                          -

                                                          The options will be defaulted by the config field, which itself -is defaulted by a global window.RufflePlayer.config.

                                                          -

                                                        Returns Promise<void>

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.load

                                                        -

                                                      • Resumes the movie from suspension.

                                                        -

                                                        The movie will now resume executing any frames, scripts and sounds. -If the movie is not suspended or no movie is loaded, this method will do nothing.

                                                        -

                                                        Returns void

                                                        This method was confusingly named and kept for legacy compatibility. -"Playing" in this context referred to "not being suspended", and not the Flash concept of playing/paused.

                                                        -

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.resume

                                                        -

                                                      • Exported function that requests the browser to change the fullscreen state if -it is allowed.

                                                        -

                                                        Parameters

                                                        • isFull: boolean

                                                          Whether to set to fullscreen or return to normal.

                                                          -

                                                        Returns void

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.requestFullscreen or PlayerV1.exitFullscreen.

                                                        -

                                                      • Requests the browser to no longer make this player fullscreen.

                                                        -

                                                        Returns void

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.exitFullscreen

                                                        -

                                                      • Suspends the movie.

                                                        -

                                                        A suspended movie will not execute any frames, scripts or sounds. -This movie is considered inactive and will not wake up until resumed. -If the movie is already suspended or no movie is loaded, this method will do nothing.

                                                        -

                                                        Returns void

                                                        This method was confusingly named and kept for legacy compatibility. -"Pause" in this context referred to "suspended", and not the Flash concept of playing/paused.

                                                        -

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.suspend

                                                        -

                                                      • Show a dismissible message in front of the player.

                                                        -

                                                        Parameters

                                                        • message: string

                                                          The message shown to the user.

                                                          -

                                                        Returns void

                                                        Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.displayMessage

                                                        -

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Properties
                                                      Accessors
                                                      Methods
                                                      diff --git a/master/interfaces/Player.MovieMetadata.html b/master/interfaces/Player.MovieMetadata.html deleted file mode 100644 index d4ee5ee8f..000000000 --- a/master/interfaces/Player.MovieMetadata.html +++ /dev/null @@ -1,19 +0,0 @@ -MovieMetadata | ruffle-core
                                                      ruffle-core
                                                        Preparing search index...

                                                        Interface MovieMetadata

                                                        Metadata about a loaded SWF file.

                                                        -
                                                        interface MovieMetadata {
                                                            width: number;
                                                            height: number;
                                                            frameRate: number;
                                                            numFrames: number;
                                                            swfVersion: number;
                                                            backgroundColor: string | null;
                                                            isActionScript3: boolean;
                                                            uncompressedLength: number;
                                                        }
                                                        Index

                                                        Properties

                                                        width -height -frameRate -numFrames -swfVersion -backgroundColor -isActionScript3 -uncompressedLength -

                                                        Properties

                                                        width: number

                                                        The width of the movie in pixels.

                                                        -
                                                        height: number

                                                        The height of the movie in pixels.

                                                        -
                                                        frameRate: number

                                                        The frame rate of the movie in frames per second.

                                                        -
                                                        numFrames: number

                                                        The number of frames on the root timeline of the movie.

                                                        -
                                                        swfVersion: number

                                                        The SWF version of the movie.

                                                        -
                                                        backgroundColor: string | null

                                                        The background color of the movie as a hex string, such as "#FFFFFF". -May be null if the background color is unavailable.

                                                        -
                                                        isActionScript3: boolean

                                                        Whether this movie is an ActionScript 3.0 movie.

                                                        -
                                                        uncompressedLength: number

                                                        Uncompressed length in bytes.

                                                        -

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Properties
                                                        diff --git a/master/interfaces/Player.PlayerElement.html b/master/interfaces/Player.PlayerElement.html deleted file mode 100644 index d73824ad7..000000000 --- a/master/interfaces/Player.PlayerElement.html +++ /dev/null @@ -1,165 +0,0 @@ -PlayerElement | ruffle-core
                                                        ruffle-core
                                                          Preparing search index...

                                                          Interface PlayerElement

                                                          A Ruffle player's HTML element.

                                                          -

                                                          This is either created through window.RufflePlayer.newest().createPlayer(), or polyfilled from a <embed>/<object> tag.

                                                          -

                                                          In addition to usual HTML attributes, this player contains methods and properties that belong to both -the Flash JS API and legacy Ruffle APIs. You are strongly discouraged from using them, and should instead -use .ruffle(version) to access a versioned API interface.

                                                          -
                                                          interface PlayerElement {
                                                              ruffle<V extends 1 = 1>(version?: V): APIVersions[V];
                                                              onFSCommand: ((command: string, args: string) => void) | null;
                                                              config: object | URLLoadOptions | DataLoadOptions;
                                                              loadedConfig: URLLoadOptions | DataLoadOptions | null;
                                                              get readyState(): ReadyState;
                                                              get metadata(): MovieMetadata | null;
                                                              reload(): Promise<void>;
                                                              load(options: string | URLLoadOptions | DataLoadOptions): Promise<void>;
                                                              play(): void;
                                                              get isPlaying(): boolean;
                                                              get volume(): number;
                                                              set volume(value: number): void;
                                                              get fullscreenEnabled(): boolean;
                                                              get isFullscreen(): boolean;
                                                              setFullscreen(isFull: boolean): void;
                                                              enterFullscreen(): void;
                                                              exitFullscreen(): void;
                                                              pause(): void;
                                                              set traceObserver(observer: ((message: string) => void) | null): void;
                                                              downloadSwf(): Promise<void>;
                                                              displayMessage(message: string): void;
                                                              PercentLoaded(): number;
                                                          }

                                                          Hierarchy (View Summary)

                                                          Index

                                                          Properties

                                                          onFSCommand -config -loadedConfig -

                                                          Accessors

                                                          readyState -metadata -isPlaying -volume -fullscreenEnabled -isFullscreen -traceObserver -

                                                          Methods

                                                          ruffle -reload -load -play -setFullscreen -enterFullscreen -exitFullscreen -pause -downloadSwf -displayMessage -PercentLoaded -

                                                          Properties

                                                          onFSCommand: ((command: string, args: string) => void) | null

                                                          Adds a handler for arbitrary "fs commands" from a movie in this player.

                                                          -

                                                          Type Declaration

                                                          • (command: string, args: string) => void
                                                              • (command: string, args: string): void

                                                              • Parameters

                                                                • command: string

                                                                  An arbitrary name of a command.

                                                                  -
                                                                • args: string

                                                                  An arbitrary argument to the command.

                                                                  -

                                                                Returns void

                                                          • null

                                                          If script access is allowed, a movie may communicate to the page through the ActionScript method fscommand(name, args).

                                                          -

                                                          The exact commands and their arguments are more or less arbitrary and up to the movie. -This is an incredibly deprecated way of communicating between Flash and JavaScript, -and was deprecated in favor of ExternalInterface in Flash Player 8 (2005).

                                                          -

                                                          Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.addFSCommandHandler, which supports multiple handlers.

                                                          -
                                                          config: object | URLLoadOptions | DataLoadOptions

                                                          Any configuration that should apply to this specific player. -This will be defaulted with any global configuration.

                                                          -

                                                          Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.config

                                                          -
                                                          loadedConfig: URLLoadOptions | DataLoadOptions | null

                                                          The effective config loaded with the last call to load(). -If no such call has been made, this will be null.

                                                          -

                                                          Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.loadedConfig

                                                          -

                                                          Accessors

                                                          • get readyState(): ReadyState

                                                            Indicates the readiness of the playing movie.

                                                            -

                                                            Returns ReadyState

                                                            The ReadyState of the player.

                                                            -

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.readyState

                                                            -
                                                          • get metadata(): MovieMetadata | null

                                                            The metadata of the playing movie (such as movie width and height). -These are inherent properties stored in the SWF file and are not affected by runtime changes. -For example, metadata.width is the width of the SWF file, and not the width of the Ruffle player.

                                                            -

                                                            Returns MovieMetadata | null

                                                            The metadata of the movie, or null if the movie metadata has not yet loaded.

                                                            -

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.metadata

                                                            -
                                                          • get isPlaying(): boolean

                                                            Checks if this player is not suspended.

                                                            -

                                                            A suspended movie will not execute any frames, scripts or sounds. -This movie is considered inactive and will not wake up until resumed. -If no movie is loaded, this method will return true.

                                                            -

                                                            Returns boolean

                                                            True if this player is playing, false if it's paused or hasn't started yet.

                                                            -

                                                            This method was confusingly named and kept for legacy compatibility. -"Playing" in this context referred to "not being suspended", and not the Flash concept of playing/paused.

                                                            -

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.suspended (though inversed!)

                                                            -
                                                          • get volume(): number

                                                            Returns the master volume of the player.

                                                            -

                                                            The volume is linear and not adapted for logarithmic hearing.

                                                            -

                                                            Returns number

                                                            The volume. 1.0 is 100% volume.

                                                            -

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.volume

                                                            -
                                                          • set volume(value: number): void

                                                            Sets the master volume of the player.

                                                            -

                                                            The volume should be linear and not adapted for logarithmic hearing.

                                                            -

                                                            Parameters

                                                            • value: number

                                                              The volume. 1.0 is 100% volume.

                                                              -

                                                            Returns void

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.volume

                                                            -
                                                          • get fullscreenEnabled(): boolean

                                                            Checks if this player is allowed to be fullscreen by the browser.

                                                            -

                                                            Returns boolean

                                                            True if you may call enterFullscreen.

                                                            -

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.fullscreenEnabled

                                                            -
                                                          • get isFullscreen(): boolean

                                                            Checks if this player is currently fullscreen inside the browser.

                                                            -

                                                            Returns boolean

                                                            True if it is fullscreen.

                                                            -

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.isFullscreen

                                                            -
                                                          • set traceObserver(observer: ((message: string) => void) | null): void

                                                            Sets a trace observer on this flash player.

                                                            -

                                                            The observer will be called, as a function, for each message that the playing movie will "trace" (output).

                                                            -

                                                            Parameters

                                                            • observer: ((message: string) => void) | null

                                                              The observer that will be called for each trace.

                                                              -

                                                            Returns void

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.traceObserver

                                                            -

                                                          Methods

                                                          • Access a specific version of the Ruffle API. -If the given version is not supported, an error is thrown.

                                                            -

                                                            Type Parameters

                                                            • V extends 1 = 1

                                                            Parameters

                                                            • Optionalversion: V

                                                              Version of the API to access. Defaults to 1.

                                                              -

                                                            Returns APIVersions[V]

                                                          • Reloads the player, as if you called load with the same config as the last time it was called.

                                                            -

                                                            If this player has never been loaded, this method will return an error.

                                                            -

                                                            Returns Promise<void>

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.reload

                                                            -

                                                          • Loads a specified movie into this player.

                                                            -

                                                            This will replace any existing movie that may be playing.

                                                            -

                                                            Parameters

                                                            • options: string | URLLoadOptions | DataLoadOptions

                                                              One of the following:

                                                              -
                                                                -
                                                              • A URL, passed as a string, which will load a URL with default options.
                                                                • -
                                                              • A URLLoadOptions object, to load a URL with options.
                                                                • -
                                                              • A DataLoadOptions object, to load data with options. -The options, if provided, must only contain values provided for this specific movie. -They must not contain any default values, since those would overwrite other configuration -settings with a lower priority (e.g. the general RufflePlayer config).
                                                                • -
                                                              -

                                                              The options will be defaulted by the config field, which itself -is defaulted by a global window.RufflePlayer.config.

                                                              -

                                                            Returns Promise<void>

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.load

                                                            -

                                                          • Resumes the movie from suspension.

                                                            -

                                                            The movie will now resume executing any frames, scripts and sounds. -If the movie is not suspended or no movie is loaded, this method will do nothing.

                                                            -

                                                            Returns void

                                                            This method was confusingly named and kept for legacy compatibility. -"Playing" in this context referred to "not being suspended", and not the Flash concept of playing/paused.

                                                            -

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.resume

                                                            -

                                                          • Suspends the movie.

                                                            -

                                                            A suspended movie will not execute any frames, scripts or sounds. -This movie is considered inactive and will not wake up until resumed. -If the movie is already suspended or no movie is loaded, this method will do nothing.

                                                            -

                                                            Returns void

                                                            This method was confusingly named and kept for legacy compatibility. -"Pause" in this context referred to "suspended", and not the Flash concept of playing/paused.

                                                            -

                                                            Please use ruffle() to access a versioned API. -This method may be replaced by Flash and is not guaranteed to exist. -A direct replacement is PlayerV1.suspend

                                                            -

                                                          • Returns the movies loaded process, in a percent from 0 to 100. -Ruffle may just return 0 or 100.

                                                            -

                                                            Returns number

                                                            a value from 0 to 100, inclusive.

                                                            -

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Properties
                                                          Accessors
                                                          Methods
                                                          diff --git a/master/interfaces/Player.PlayerV1.html b/master/interfaces/Player.PlayerV1.html deleted file mode 100644 index fe7941f45..000000000 --- a/master/interfaces/Player.PlayerV1.html +++ /dev/null @@ -1,102 +0,0 @@ -PlayerV1 | ruffle-core
                                                          ruffle-core
                                                            Preparing search index...

                                                            Interface PlayerV1

                                                            interface PlayerV1 {
                                                                addFSCommandHandler(
                                                                    handler: (command: string, args: string) => void,
                                                                ): void;
                                                                config: object | URLLoadOptions | DataLoadOptions;
                                                                loadedConfig: URLLoadOptions | DataLoadOptions | null;
                                                                get readyState(): ReadyState;
                                                                get metadata(): MovieMetadata | null;
                                                                reload(): Promise<void>;
                                                                load(options: string | URLLoadOptions | DataLoadOptions): Promise<void>;
                                                                get volume(): number;
                                                                set volume(value: number): void;
                                                                get fullscreenEnabled(): boolean;
                                                                get isFullscreen(): boolean;
                                                                requestFullscreen(): void;
                                                                exitFullscreen(): void;
                                                                get suspended(): boolean;
                                                                suspend(): void;
                                                                resume(): void;
                                                                set traceObserver(observer: ((message: string) => void) | null): void;
                                                                downloadSwf(): Promise<void>;
                                                                displayMessage(message: string): void;
                                                                callExternalInterface(name: string, ...args: unknown[]): unknown;
                                                            }
                                                            Index

                                                            Properties

                                                            config -loadedConfig -

                                                            Accessors

                                                            readyState -metadata -volume -fullscreenEnabled -isFullscreen -suspended -traceObserver -

                                                            Methods

                                                            addFSCommandHandler -reload -load -requestFullscreen -exitFullscreen -suspend -resume -downloadSwf -displayMessage -callExternalInterface -

                                                            Properties

                                                            config: object | URLLoadOptions | DataLoadOptions

                                                            Any configuration that should apply to this specific player. -This will be defaulted with any global configuration.

                                                            -
                                                            loadedConfig: URLLoadOptions | DataLoadOptions | null

                                                            The effective config loaded with the last call to load(). -If no such call has been made, this will be null.

                                                            -

                                                            Accessors

                                                            • get metadata(): MovieMetadata | null

                                                              The metadata of the playing movie (such as movie width and height). -These are inherent properties stored in the SWF file and are not affected by runtime changes. -For example, metadata.width is the width of the SWF file, and not the width of the Ruffle player.

                                                              -

                                                              Returns MovieMetadata | null

                                                              The metadata of the movie, or null if the movie metadata has not yet loaded.

                                                              -
                                                            • get volume(): number

                                                              Returns the master volume of the player.

                                                              -

                                                              The volume is linear and not adapted for logarithmic hearing.

                                                              -

                                                              Returns number

                                                              The volume. 1.0 is 100% volume.

                                                              -
                                                            • set volume(value: number): void

                                                              Sets the master volume of the player.

                                                              -

                                                              The volume should be linear and not adapted for logarithmic hearing.

                                                              -

                                                              Parameters

                                                              • value: number

                                                                The volume. 1.0 is 100% volume.

                                                                -

                                                              Returns void

                                                            • get isFullscreen(): boolean

                                                              Checks if this player is currently fullscreen inside the browser.

                                                              -

                                                              Returns boolean

                                                              True if it is fullscreen.

                                                              -
                                                            • get suspended(): boolean

                                                              Checks if this movie is suspended.

                                                              -

                                                              A suspended movie will not execute any frames, scripts or sounds. -This movie is considered inactive and will not wake up until resumed. -If no movie is loaded, this method will return true.

                                                              -

                                                              Returns boolean

                                                              true if the movie is suspended or does not exist, false if the movie is playing

                                                              -
                                                                -
                                                              • suspend to suspend the player
                                                                • -
                                                              • resume to resume the player from suspension
                                                                • -
                                                              -
                                                            • set traceObserver(observer: ((message: string) => void) | null): void

                                                              Sets a trace observer on this flash player.

                                                              -

                                                              The observer will be called, as a function, for each message that the playing movie will "trace" (output).

                                                              -

                                                              Parameters

                                                              • observer: ((message: string) => void) | null

                                                                The observer that will be called for each trace.

                                                                -

                                                              Returns void

                                                            Methods

                                                            • Adds a handler for arbitrary "fs commands" from a movie in this player.

                                                              -

                                                              Parameters

                                                              • handler: (command: string, args: string) => void

                                                                A command handler to receive fscommands.

                                                                -
                                                                  • (command: string, args: string): void

                                                                  • Parameters

                                                                    • command: string

                                                                      An arbitrary name of a command.

                                                                      -
                                                                    • args: string

                                                                      An arbitrary argument to the command.

                                                                      -

                                                                    Returns void

                                                              Returns void

                                                              If script access is allowed, a movie may communicate to the page through the ActionScript method fscommand(name, args).

                                                              -

                                                              The exact commands and their arguments are more or less arbitrary and up to the movie. -This is an incredibly deprecated way of communicating between Flash and JavaScript, -and was deprecated in favor of ExternalInterface in Flash Player 8 (2005).

                                                              -

                                                            • Reloads the player, as if you called load with the same config as the last time it was called.

                                                              -

                                                              If this player has never been loaded, this method will return an error.

                                                              -

                                                              Returns Promise<void>

                                                            • Loads a specified movie into this player.

                                                              -

                                                              This will replace any existing movie that may be playing.

                                                              -

                                                              Parameters

                                                              • options: string | URLLoadOptions | DataLoadOptions

                                                                One of the following:

                                                                -
                                                                  -
                                                                • A URL, passed as a string, which will load a URL with default options.
                                                                  • -
                                                                • A URLLoadOptions object, to load a URL with options.
                                                                  • -
                                                                • A DataLoadOptions object, to load data with options. -The options, if provided, must only contain values provided for this specific movie. -They must not contain any default values, since those would overwrite other configuration -settings with a lower priority (e.g. the general RufflePlayer config).
                                                                  • -
                                                                -

                                                                The options will be defaulted by the config field, which itself -is defaulted by a global window.RufflePlayer.config.

                                                                -

                                                              Returns Promise<void>

                                                            • Requests the browser to no longer make this player fullscreen.

                                                              -

                                                              Returns void

                                                            • Suspends the movie.

                                                              -

                                                              A suspended movie will not execute any frames, scripts or sounds. -This movie is considered inactive and will not wake up until resumed. -If the movie is already suspended or no movie is loaded, this method will do nothing.

                                                              -

                                                              Returns void

                                                                -
                                                              • suspended to check if the player is suspended
                                                                • -
                                                              • resume to resume the player from suspension
                                                                • -
                                                              -

                                                            • Resumes the movie from suspension.

                                                              -

                                                              The movie will now resume executing any frames, scripts and sounds. -If the movie is not suspended or no movie is loaded, this method will do nothing.

                                                              -

                                                              Returns void

                                                                -
                                                              • suspended to suspend the player
                                                                • -
                                                              • suspend to check if the player is suspended
                                                                • -
                                                              -

                                                            • Show a dismissible message in front of the player.

                                                              -

                                                              Parameters

                                                              • message: string

                                                                The message shown to the user.

                                                                -

                                                              Returns void

                                                            • Calls an External Interface callback with the given name and arguments.

                                                              -

                                                              This will call any ActionScript code assigned to the given name. -If no such External Interface callback exists with the given name, this method silently fails and returns undefined.

                                                              -

                                                              Parameters

                                                              • name: string

                                                                Name of the callback to call.

                                                                -
                                                              • ...args: unknown[]

                                                                Any arguments to pass to the callback.

                                                                -

                                                              Returns unknown

                                                              Any value returned by the callback.

                                                              -

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Properties
                                                            Accessors
                                                            Methods
                                                            diff --git a/master/interfaces/Setup.InstallationOptions.html b/master/interfaces/Setup.InstallationOptions.html deleted file mode 100644 index a8c3f400d..000000000 --- a/master/interfaces/Setup.InstallationOptions.html +++ /dev/null @@ -1,7 +0,0 @@ -InstallationOptions | ruffle-core
                                                            ruffle-core
                                                              Preparing search index...

                                                              Interface InstallationOptions

                                                              Options to use with this specific installation of Ruffle.

                                                              -

                                                              This is mostly to provide a way to configure environmental settings, like using -onFirstLoad to potentially configure webpack prior to loading wasm files.

                                                              -
                                                              interface InstallationOptions {
                                                                  onFirstLoad?: () => void;
                                                              }
                                                              Index

                                                              Properties

                                                              onFirstLoad? -

                                                              Properties

                                                              onFirstLoad?: () => void

                                                              A callback to be run before the very first time Ruffle is loaded. -This may be used to configure a bundler prior to asset loading.

                                                              -

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Properties
                                                              diff --git a/master/interfaces/Setup.PublicAPILike.html b/master/interfaces/Setup.PublicAPILike.html deleted file mode 100644 index 5be011858..000000000 --- a/master/interfaces/Setup.PublicAPILike.html +++ /dev/null @@ -1,9 +0,0 @@ -PublicAPILike | ruffle-core
                                                              ruffle-core
                                                                Preparing search index...

                                                                Interface PublicAPILike

                                                                Represents a potential installation of a Ruffle public API.

                                                                -

                                                                Unlike PublicAPI, this may come from any source, past or future. -It needs to be forwards compatible and convertible into a modern day PublicAPI.

                                                                -
                                                                interface PublicAPILike {
                                                                    config?: object | URLLoadOptions | DataLoadOptions;
                                                                    sources?: Record<string, SourceAPI>;
                                                                    invoked?: boolean;
                                                                    newestName?: string | null;
                                                                    superseded?(): void;
                                                                }

                                                                Implemented by

                                                                Index

                                                                Properties

                                                                config? -sources? -invoked? -newestName? -

                                                                Methods

                                                                superseded? -

                                                                Properties

                                                                config?: object | URLLoadOptions | DataLoadOptions
                                                                sources?: Record<string, SourceAPI>
                                                                invoked?: boolean
                                                                newestName?: string | null

                                                                Methods

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Properties
                                                                Methods
                                                                diff --git a/master/interfaces/Setup.SourceAPI.html b/master/interfaces/Setup.SourceAPI.html deleted file mode 100644 index 07f7aaeba..000000000 --- a/master/interfaces/Setup.SourceAPI.html +++ /dev/null @@ -1,18 +0,0 @@ -SourceAPI | ruffle-core
                                                                ruffle-core
                                                                  Preparing search index...

                                                                  Interface SourceAPI

                                                                  Represents this particular version of Ruffle.

                                                                  -

                                                                  Multiple APIs can be instantiated from different sources; e.g. an "extension" -version, versus a "local" version. This expresses to the Public API -negotiator (see PublicAPI) what this particular version of Ruffle is and -how to control it.

                                                                  -
                                                                  interface SourceAPI {
                                                                      version: string;
                                                                      polyfill(): void;
                                                                      pluginPolyfill(): void;
                                                                      createPlayer(): PlayerElement;
                                                                  }
                                                                  Index

                                                                  Properties

                                                                  version -

                                                                  Methods

                                                                  polyfill -pluginPolyfill -createPlayer -

                                                                  Properties

                                                                  version: string

                                                                  The version of this particular API, as a string in a semver compatible format.

                                                                  -

                                                                  Methods

                                                                  • Start up the polyfills.

                                                                    -

                                                                    Do not run polyfills for more than one Ruffle source at a time.

                                                                    -

                                                                    Returns void

                                                                  • Polyfill the plugin detection.

                                                                    -

                                                                    This needs to run before any plugin detection script does.

                                                                    -

                                                                    Returns void

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Properties
                                                                  Methods
                                                                  diff --git a/master/interfaces/baseloadoptions.html b/master/interfaces/baseloadoptions.html new file mode 100644 index 000000000..f5223c5d4 --- /dev/null +++ b/master/interfaces/baseloadoptions.html @@ -0,0 +1,348 @@ + + + + + + BaseLoadOptions | ruffle-core + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + Options +
                                                                  +
                                                                  + All +
                                                                    +
                                                                  • Public
                                                                    • +
                                                                  • Public/Protected
                                                                    • +
                                                                  • All
                                                                    • +
                                                                  +
                                                                  + + + + +
                                                                  +
                                                                  + Menu +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Interface BaseLoadOptions

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Any options used for loading a movie.

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Hierarchy

                                                                  + +
                                                                  +
                                                                  +

                                                                  Index

                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Properties

                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Properties

                                                                  +
                                                                  + +

                                                                  Optional autoplay

                                                                  +
                                                                  autoplay: undefined | On | Off | Auto
                                                                  + +
                                                                  +
                                                                  +

                                                                  Controls the auto-play behaviour of Ruffle.

                                                                  +
                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  AutoPlay.Auto

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional parameters

                                                                  +
                                                                  parameters: undefined | string | Record<string, string> | URLSearchParams
                                                                  + +
                                                                  +
                                                                  +

                                                                  Also known as "flashvars" - these are values that may be passed to + and loaded by the movie.

                                                                  +
                                                                  +

                                                                  If a URL if specified when loading the movie, some parameters will + be extracted by the query portion of that URL and then overwritten + by any explicitly set here.

                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional unmuteOverlay

                                                                  +
                                                                  unmuteOverlay: undefined | Visible | Hidden
                                                                  + +
                                                                  +
                                                                  +

                                                                  Controls the visibility of the unmute overlay when the player + is started muted.

                                                                  +
                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  UnmuteOverlay.Visible

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional upgradeToHttps

                                                                  +
                                                                  upgradeToHttps: undefined | boolean
                                                                  + +
                                                                  +
                                                                  +

                                                                  Whether or not to auto-upgrade all embedded URLs to https.

                                                                  +
                                                                  +

                                                                  Flash content that embeds http urls will be blocked from + accessing those urls by the browser when Ruffle is loaded + in a https context. Set to true to automatically change + http:// to https:// for all embedded URLs when Ruffle is + loaded in an https context.

                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  true

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Legend

                                                                  +
                                                                  +
                                                                    +
                                                                  • Constructor
                                                                    • +
                                                                  • Property
                                                                    • +
                                                                  • Method
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Inherited constructor
                                                                    • +
                                                                  • Inherited property
                                                                    • +
                                                                  • Inherited method
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Property
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Static method
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Generated using TypeDoc

                                                                  +
                                                                  +
                                                                  + + + \ No newline at end of file diff --git a/master/interfaces/config.html b/master/interfaces/config.html new file mode 100644 index 000000000..8bee76273 --- /dev/null +++ b/master/interfaces/config.html @@ -0,0 +1,414 @@ + + + + + + Config | ruffle-core + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + Options +
                                                                  +
                                                                  + All +
                                                                    +
                                                                  • Public
                                                                    • +
                                                                  • Public/Protected
                                                                    • +
                                                                  • All
                                                                    • +
                                                                  +
                                                                  + + + + +
                                                                  +
                                                                  + Menu +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Interface Config

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  The configuration object to control Ruffle's behaviour on the website + that it is included on.

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Hierarchy

                                                                  + +
                                                                  +
                                                                  +

                                                                  Index

                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Properties

                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Properties

                                                                  +
                                                                  + +

                                                                  Optional autoplay

                                                                  +
                                                                  autoplay: undefined | On | Off | Auto
                                                                  + +
                                                                  +
                                                                  +

                                                                  Controls the auto-play behaviour of Ruffle.

                                                                  +
                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  AutoPlay.Auto

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional parameters

                                                                  +
                                                                  parameters: undefined | string | Record<string, string> | URLSearchParams
                                                                  + +
                                                                  +
                                                                  +

                                                                  Also known as "flashvars" - these are values that may be passed to + and loaded by the movie.

                                                                  +
                                                                  +

                                                                  If a URL if specified when loading the movie, some parameters will + be extracted by the query portion of that URL and then overwritten + by any explicitly set here.

                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional polyfills

                                                                  +
                                                                  polyfills: undefined | boolean
                                                                  + +
                                                                  +
                                                                  +

                                                                  Whether or not to enable polyfills on the page.

                                                                  +
                                                                  +

                                                                  Polyfills will look for "legacy" flash content like <object> + and <embed> elements, and replace them with compatible + Ruffle elements.

                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  true

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional publicPath

                                                                  +
                                                                  publicPath: undefined | string
                                                                  + +
                                                                  +
                                                                  +

                                                                  The URL at which Ruffle can load its extra files (ie .wasm).

                                                                  +
                                                                  +

                                                                  [publicPaths] is consulted first for a source-specific URL, + with this field being a fallback.

                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional publicPaths

                                                                  +
                                                                  publicPaths: undefined | Record<string, string>
                                                                  + +
                                                                  +
                                                                  +

                                                                  A map of public paths from source name to URL.

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional unmuteOverlay

                                                                  +
                                                                  unmuteOverlay: undefined | Visible | Hidden
                                                                  + +
                                                                  +
                                                                  +

                                                                  Controls the visibility of the unmute overlay when the player + is started muted.

                                                                  +
                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  UnmuteOverlay.Visible

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional upgradeToHttps

                                                                  +
                                                                  upgradeToHttps: undefined | boolean
                                                                  + +
                                                                  +
                                                                  +

                                                                  Whether or not to auto-upgrade all embedded URLs to https.

                                                                  +
                                                                  +

                                                                  Flash content that embeds http urls will be blocked from + accessing those urls by the browser when Ruffle is loaded + in a https context. Set to true to automatically change + http:// to https:// for all embedded URLs when Ruffle is + loaded in an https context.

                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  true

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Legend

                                                                  +
                                                                  +
                                                                    +
                                                                  • Constructor
                                                                    • +
                                                                  • Property
                                                                    • +
                                                                  • Method
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Inherited constructor
                                                                    • +
                                                                  • Inherited property
                                                                    • +
                                                                  • Inherited method
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Property
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Static method
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Generated using TypeDoc

                                                                  +
                                                                  +
                                                                  + + + \ No newline at end of file diff --git a/master/interfaces/dataloadoptions.html b/master/interfaces/dataloadoptions.html new file mode 100644 index 000000000..37982b440 --- /dev/null +++ b/master/interfaces/dataloadoptions.html @@ -0,0 +1,365 @@ + + + + + + DataLoadOptions | ruffle-core + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + Options +
                                                                  +
                                                                  + All +
                                                                    +
                                                                  • Public
                                                                    • +
                                                                  • Public/Protected
                                                                    • +
                                                                  • All
                                                                    • +
                                                                  +
                                                                  + + + + +
                                                                  +
                                                                  + Menu +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Interface DataLoadOptions

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Options to load a movie by a data stream.

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Hierarchy

                                                                  + +
                                                                  +
                                                                  +

                                                                  Index

                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Properties

                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Properties

                                                                  +
                                                                  + +

                                                                  Optional autoplay

                                                                  +
                                                                  autoplay: undefined | On | Off | Auto
                                                                  + +
                                                                  +
                                                                  +

                                                                  Controls the auto-play behaviour of Ruffle.

                                                                  +
                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  AutoPlay.Auto

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  data

                                                                  +
                                                                  data: Iterable<number>
                                                                  + +
                                                                  +
                                                                  +

                                                                  The data to load a movie from.

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional parameters

                                                                  +
                                                                  parameters: undefined | string | Record<string, string> | URLSearchParams
                                                                  + +
                                                                  +
                                                                  +

                                                                  Also known as "flashvars" - these are values that may be passed to + and loaded by the movie.

                                                                  +
                                                                  +

                                                                  If a URL if specified when loading the movie, some parameters will + be extracted by the query portion of that URL and then overwritten + by any explicitly set here.

                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional unmuteOverlay

                                                                  +
                                                                  unmuteOverlay: undefined | Visible | Hidden
                                                                  + +
                                                                  +
                                                                  +

                                                                  Controls the visibility of the unmute overlay when the player + is started muted.

                                                                  +
                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  UnmuteOverlay.Visible

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional upgradeToHttps

                                                                  +
                                                                  upgradeToHttps: undefined | boolean
                                                                  + +
                                                                  +
                                                                  +

                                                                  Whether or not to auto-upgrade all embedded URLs to https.

                                                                  +
                                                                  +

                                                                  Flash content that embeds http urls will be blocked from + accessing those urls by the browser when Ruffle is loaded + in a https context. Set to true to automatically change + http:// to https:// for all embedded URLs when Ruffle is + loaded in an https context.

                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  true

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Legend

                                                                  +
                                                                  +
                                                                    +
                                                                  • Constructor
                                                                    • +
                                                                  • Property
                                                                    • +
                                                                  • Method
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Inherited constructor
                                                                    • +
                                                                  • Inherited property
                                                                    • +
                                                                  • Inherited method
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Property
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Static method
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Generated using TypeDoc

                                                                  +
                                                                  +
                                                                  + + + \ No newline at end of file diff --git a/master/interfaces/urlloadoptions.html b/master/interfaces/urlloadoptions.html new file mode 100644 index 000000000..e3d24461f --- /dev/null +++ b/master/interfaces/urlloadoptions.html @@ -0,0 +1,367 @@ + + + + + + URLLoadOptions | ruffle-core + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + Options +
                                                                  +
                                                                  + All +
                                                                    +
                                                                  • Public
                                                                    • +
                                                                  • Public/Protected
                                                                    • +
                                                                  • All
                                                                    • +
                                                                  +
                                                                  + + + + +
                                                                  +
                                                                  + Menu +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Interface URLLoadOptions

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Options to load a movie by URL.

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Hierarchy

                                                                  + +
                                                                  +
                                                                  +

                                                                  Index

                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Properties

                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Properties

                                                                  +
                                                                  + +

                                                                  Optional autoplay

                                                                  +
                                                                  autoplay: undefined | On | Off | Auto
                                                                  + +
                                                                  +
                                                                  +

                                                                  Controls the auto-play behaviour of Ruffle.

                                                                  +
                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  AutoPlay.Auto

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional parameters

                                                                  +
                                                                  parameters: undefined | string | Record<string, string> | URLSearchParams
                                                                  + +
                                                                  +
                                                                  +

                                                                  Also known as "flashvars" - these are values that may be passed to + and loaded by the movie.

                                                                  +
                                                                  +

                                                                  If a URL if specified when loading the movie, some parameters will + be extracted by the query portion of that URL and then overwritten + by any explicitly set here.

                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional unmuteOverlay

                                                                  +
                                                                  unmuteOverlay: undefined | Visible | Hidden
                                                                  + +
                                                                  +
                                                                  +

                                                                  Controls the visibility of the unmute overlay when the player + is started muted.

                                                                  +
                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  UnmuteOverlay.Visible

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Optional upgradeToHttps

                                                                  +
                                                                  upgradeToHttps: undefined | boolean
                                                                  + +
                                                                  +
                                                                  +

                                                                  Whether or not to auto-upgrade all embedded URLs to https.

                                                                  +
                                                                  +

                                                                  Flash content that embeds http urls will be blocked from + accessing those urls by the browser when Ruffle is loaded + in a https context. Set to true to automatically change + http:// to https:// for all embedded URLs when Ruffle is + loaded in an https context.

                                                                  +
                                                                  +
                                                                  default
                                                                  +

                                                                  true

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  url

                                                                  +
                                                                  url: string
                                                                  + +
                                                                  +
                                                                  +

                                                                  The URL to load a movie from.

                                                                  +
                                                                  +

                                                                  If there is a query portion of this URL, then default parameters + will be extracted from that.

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Legend

                                                                  +
                                                                  +
                                                                    +
                                                                  • Constructor
                                                                    • +
                                                                  • Property
                                                                    • +
                                                                  • Method
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Inherited constructor
                                                                    • +
                                                                  • Inherited property
                                                                    • +
                                                                  • Inherited method
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Property
                                                                    • +
                                                                  +
                                                                    +
                                                                  • Static method
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Generated using TypeDoc

                                                                  +
                                                                  +
                                                                  + + + \ No newline at end of file diff --git a/master/media/README.md b/master/media/README.md deleted file mode 100644 index 950ac4d5c..000000000 --- a/master/media/README.md +++ /dev/null @@ -1,167 +0,0 @@ -# ruffle-web - -![Test Web](https://github.com/ruffle-rs/ruffle/workflows/Test%20Web/badge.svg) - -ruffle-web is a Wasm version of Ruffle, intended for use by either -using the `ruffle-selfhosted` or `ruffle-extension` NPM packages. - -This project is split into two parts: The actual Flash player written in Rust, -and a javascript interface to it. Most of the time, you will be building the -actual rust part through the npm build scripts. - -## Using ruffle-web - -Please refer to our wiki for instructions on how to use Ruffle either -[on your own website](https://github.com/ruffle-rs/ruffle/wiki/Using-Ruffle#web), -or as a [browser extension](https://github.com/ruffle-rs/ruffle/wiki/Using-Ruffle#browser-extension). - -## How it works - -We compile Ruffle down to a Wasm ([WebAssembly](https://webassembly.org/)) binary, which will be loaded -into web pages either deliberately (installing the selfhosted package onto the website), or injected -by users as a browser extension. - -By default we will detect and replace any embedded Flash content on websites with the Ruffle player -(we call this "polyfilling"), but this can be configured by the website. This means that Ruffle is an -"out of the box" solution for getting Flash to work again; include Ruffle and it should just work™. - -For rendering the content, we prefer to use [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API). -WebGL is very accurate, hardware-accelerated and very fast, but is not universally supported. -Additionally, many privacy related browsers or extensions will disable WebGL by default. -For this reason, we include a fallback using [the canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API). - -## Building from source - -### Requirements - -Before you are able to build this project, you must first install a few dependencies: - -#### Rust - -Follow the instructions [to install rust](https://www.rust-lang.org/tools/install) on your machine. - -We do not have a Minimum Supported Rust Version policy. If it fails to build, it's likely you may need -to update to the latest stable version of rust. You may run `rustup update` to do this (if you installed -rust using the above instructions). - -For the compiler to be able to output WebAssembly, an additional target has to be added to it: `rustup target add wasm32-unknown-unknown` - -#### Java - -Follow the instructions [to install OpenJDK](https://openjdk.org/projects/jdk/20/) on your machine. - -We do not have a specific Java support policy. Any Java version that supports running the AS3 compiler -should work. Additionally, headless JREs should also work. - -#### Node.js - -Follow the instructions to [install Node.js](https://nodejs.org/) on your machine. - -We recommend using the currently active LTS 22, but we do also run tests with current Node.js 24. - -Note that npm 7 or newer is required. It should come bundled with Node.js 15 or newer, but can be upgraded with older Node.js versions using `npm install -g npm` as root/Administrator. - -#### wasm-bindgen - - - -This can be installed with `cargo install wasm-bindgen-cli --version 0.2.101`. Be sure to install this specific version of `wasm-bindgen-cli` to match the version used by Ruffle. - -#### Binaryen - -This is optional, used to further optimize the built WebAssembly module. -Some ways to install Binaryen: - -- download one of the [prebuilt releases](https://github.com/WebAssembly/binaryen/releases/) -- using your Linux distribution's package manager (`sudo apt install binaryen`, `sudo dnf install binaryen`) -- from [Homebrew](https://formulae.brew.sh/formula/binaryen) -- from [Anaconda](https://anaconda.org/conda-forge/binaryen) -- [compile it yourself](https://github.com/WebAssembly/binaryen#building) - -Just make sure the `wasm-opt` program is in `$PATH`, and that it works. - -#### Optional features - -##### `jpegxr` - -The release version of the extension is compiled with `jpegxr`. -To enable it, set the env `CARGO_FEATURES="jpegxr"`. - -Windows dependencies: - -- Install LLVM and add the full path of its `bin` folder (example: `C:\Program Files\LLVM-18.1.6\bin`) to your env `PATH`. -- Set env `LIBCLANG_PATH` with the same `bin` folder. - -### Building - -In this project, you may run the following commands to build all packages: - -- `npm install` - - This will install every dependency for every package. - - Run this every time you pull in new changes, otherwise you may be missing a package and the build will fail. -- `npm run build` - - This will build the wasm binary and every node package (notably selfhosted and extension). - - Output will be available in the `dist/` folder of each package (for example, `./packages/selfhosted/dist`). - - You may also use `npm run build:debug` to disable Webpack optimizations and activate the (extremely verbose) ActionScript debugging output. - - There is `npm run build:dual-wasm` as well, to build a second WebAssembly module that disables all supported WebAssembly extensions, - potentially resulting in support for more browsers, at the expense of longer build time. - - `npm run build:repro` enables reproducible builds with the default WASM module. Note that this also requires a `version_seal.json`, which is not provided in the normal Git repository - only specially-marked reproducible source archives. Running this without a version seal will generate one based on the current state of your environment. - - `npm run build:dual-wasm-repro` enables reproducible builds with both WASM modules. Note that this also requires a `version_seal.json`, which is not provided in the normal Git repository - only specially-marked reproducible source archives. Running this without a version seal will generate one based on the current state of your environment. - - You will also need to run `rustup component add rust-src` with either of the dual-wasm commands since we rebuild std for the vanilla WASM module. - -From here, you may follow the instructions to [use Ruffle on your website](packages/selfhosted/README.md), -run a demo locally with `npm run demo`, or [install the extension in your browser](https://github.com/ruffle-rs/ruffle/wiki/Using-Ruffle#browser-extension). - -### Testing - -There are two parts of tests to this project: -- Regular node tests, ran through `npm run test`. You must have built everything first as above. These have no special requirements. -- Browser based tests, ran through `npm run wdio` with extra arguments as below. These take longer to run and require some setup. - -## Browser Based Tests -There are full integration tests that require a browser to run. We don't make any assumptions about your environment, and so you must specify it yourself. - -To run these tests, first build the project as above, then use `npm run wdio -- --arg1 --arg2` etc. - -### Local Browsers -These are additive - you can specify multiple at the same time. You must have the given browsers installed locally though, or it will fail. - -- `--chrome` for Chrome -- `--firefox` for Firefox -- `--edge` for Edge - -### BrowserStack (Mobile Browsers) -To run tests on mobile devices on BrowserStack, pass the `--browserstack` argument. -We also have our "minimum supported desktop browsers" available too, by additionally passing `--oldVersions`. - -You will need a BrowserStack account (Maintainers may contact @Dinnerbone on Discord for an invite to the Ruffle team), -and set the appropriate values to `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` environment variables. - -### Other Options -Pass `--headless` to hide the browser windows. This is useful and recommended in almost every case, but if you want to debug why a test fails then it's very useful to not pass this. - -Pass `--spec ` to filter a test based on name. For example, `--spec external_interface` to tests with `external_interface` in the path. - - -### Testing tips! -If debugging a failing test, use `await browser.pause(100000);` in the test file to pause it, and don't start the test with `--headless`. -That way you can actually see what's happening, and manually get involved to debug it. - -## Structure - -- This directory is a cargo crate which is the actual Flash player, and also a root node package. -- [packages/core](packages/core) is a node package which contains the core ruffle web API & wasm bindings. -- [packages/selfhosted](packages/selfhosted) is a node package intended for consumption by websites to include Ruffle on their site. -- [packages/extension](packages/extension) is a node package that turns Ruffle into a browser extension. -- [packages/demo](packages/demo) is an example node package of how to use self-hosted ruffle on your site, and testing it locally. - -## Contributing - -Please follow the [general contribution guidelines for Ruffle](../CONTRIBUTING.md). - -In addition to those, we ask that you ensure that you pass all tests with `npm run test`, and check the automatic code -linting & styler by running `npm run format` before you commit. - -Where possible, please add tests to all new functionality or bug fixes that you contribute. - -Thank you! diff --git a/master/modules.html b/master/modules.html index de82158e0..62a1ee649 100644 --- a/master/modules.html +++ b/master/modules.html @@ -1 +1,664 @@ -ruffle-core
                                                                  ruffle-core
                                                                    Preparing search index...

                                                                      ruffle-core

                                                                      Namespaces

                                                                      Setup
                                                                      Config
                                                                      Player

                                                                      Variables

                                                                      buildInfo
                                                                      currentScriptURL
                                                                      isExtension

                                                                      Functions

                                                                      setCurrentScriptURL

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Namespaces
                                                                      Variables
                                                                      Functions
                                                                      + + + + + + ruffle-core + + + + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      + +
                                                                      +
                                                                      + Options +
                                                                      +
                                                                      + All +
                                                                        +
                                                                      • Public
                                                                        • +
                                                                      • Public/Protected
                                                                        • +
                                                                      • All
                                                                        • +
                                                                      +
                                                                      + + + + +
                                                                      +
                                                                      + Menu +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Project ruffle-core

                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Index

                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Enumerations

                                                                      + +
                                                                      +
                                                                      +

                                                                      Classes

                                                                      + +
                                                                      +
                                                                      +

                                                                      Interfaces

                                                                      + +
                                                                      +
                                                                      +

                                                                      Variables

                                                                      + +
                                                                      +
                                                                      +

                                                                      Functions

                                                                      + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Variables

                                                                      +
                                                                      + +

                                                                      Const FLASH7_AND_8_MIMETYPE

                                                                      +
                                                                      FLASH7_AND_8_MIMETYPE: "application/x-shockwave-flash2-preview" = "application/x-shockwave-flash2-preview"
                                                                      + +
                                                                      +
                                                                      + +

                                                                      Const FLASH_ACTIVEX_CLASSID

                                                                      +
                                                                      FLASH_ACTIVEX_CLASSID: "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" = "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"
                                                                      + +
                                                                      +
                                                                      + +

                                                                      Const FLASH_MIMETYPE

                                                                      +
                                                                      FLASH_MIMETYPE: "application/x-shockwave-flash" = "application/x-shockwave-flash"
                                                                      + +
                                                                      +
                                                                      + +

                                                                      Const FLASH_MOVIE_MIMETYPE

                                                                      +
                                                                      FLASH_MOVIE_MIMETYPE: "application/vnd.adobe.flash-movie" = "application/vnd.adobe.flash-movie"
                                                                      + +
                                                                      +
                                                                      + +

                                                                      Const FLASH_PLUGIN

                                                                      +
                                                                      FLASH_PLUGIN: RufflePlugin = ...
                                                                      + +
                                                                      +
                                                                      +

                                                                      A fake plugin designed to trigger Flash detection scripts.

                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + +

                                                                      Const FUTURESPLASH_MIMETYPE

                                                                      +
                                                                      FUTURESPLASH_MIMETYPE: "application/futuresplash" = "application/futuresplash"
                                                                      + +
                                                                      +
                                                                      + +

                                                                      Const ruffleShadowTemplate

                                                                      +
                                                                      ruffleShadowTemplate: HTMLTemplateElement = ...
                                                                      + +
                                                                      +
                                                                      +

                                                                      The shadow template which is used to fill the actual Ruffle player element + on the page.

                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Functions

                                                                      +
                                                                      + +

                                                                      copyToAudioBuffer

                                                                      +
                                                                        +
                                                                      • copyToAudioBuffer(audioBuffer: AudioBuffer, leftData: ArrayLike<number>, rightData: ArrayLike<number>): void
                                                                        • +
                                                                      +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Copies data into the given audio channel. + This is necessary because Safari does not support AudioBuffer.copyToChannel.

                                                                        +
                                                                        +
                                                                        +
                                                                        internal
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Parameters

                                                                        +
                                                                          +
                                                                        • +
                                                                          audioBuffer: AudioBuffer
                                                                          +
                                                                          • +
                                                                        • +
                                                                          leftData: ArrayLike<number>
                                                                          +
                                                                          • +
                                                                        • +
                                                                          rightData: ArrayLike<number>
                                                                          +
                                                                          • +
                                                                        +

                                                                        Returns void

                                                                        +
                                                                        • +
                                                                      +
                                                                      +
                                                                      + +

                                                                      installPlugin

                                                                      +
                                                                        +
                                                                      • installPlugin(plugin: RufflePlugin): void
                                                                        • +
                                                                      +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Install a fake plugin such that detectors will see it in navigator.plugins.

                                                                        +
                                                                        +

                                                                        This function takes care to check if the existing implementation of + navigator.plugins already accepts fake plugin entries. If so, it will use + that version of the plugin array. This allows the plugin polyfill to compose + across multiple plugin emulators with the first emulator's polyfill winning.

                                                                        +
                                                                        +

                                                                        Parameters

                                                                        +
                                                                          +
                                                                        • +
                                                                          plugin: RufflePlugin
                                                                          +
                                                                          +

                                                                          The plugin to install

                                                                          +
                                                                          +
                                                                          • +
                                                                        +

                                                                        Returns void

                                                                        +
                                                                        • +
                                                                      +
                                                                      +
                                                                      + +

                                                                      isSwfFilename

                                                                      +
                                                                        +
                                                                      • isSwfFilename(filename: null | string): boolean
                                                                        • +
                                                                      +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Returns whether the given filename ends in a known flash extension.

                                                                        +
                                                                        +
                                                                        +

                                                                        Parameters

                                                                        +
                                                                          +
                                                                        • +
                                                                          filename: null | string
                                                                          +
                                                                          +

                                                                          The filename to test.

                                                                          +
                                                                          +
                                                                          • +
                                                                        +

                                                                        Returns boolean

                                                                        +

                                                                        True if the filename is a flash movie (swf or spl).

                                                                        +
                                                                        • +
                                                                      +
                                                                      +
                                                                      + +

                                                                      loadRuffle

                                                                      +
                                                                        +
                                                                      • loadRuffle(): Promise<(...args: any[]) => Ruffle>
                                                                        • +
                                                                      +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Obtain an instance of Ruffle.

                                                                        +
                                                                        +

                                                                        This function returns a promise which yields Ruffle asynchronously.

                                                                        +
                                                                        +

                                                                        Returns Promise<(...args: any[]) => Ruffle>

                                                                        +

                                                                        A ruffle constructor that may be used to create new Ruffle + instances.

                                                                        +
                                                                        • +
                                                                      +
                                                                      +
                                                                      + +

                                                                      lookupElement

                                                                      +
                                                                        +
                                                                      • lookupElement(elementName: string): null | Registration
                                                                        • +
                                                                      +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Lookup a previously registered custom element.

                                                                        +
                                                                        +

                                                                        The returned object will have name, class, and internal_name + properties listing the external name, implementing class, and internal name + respectively.

                                                                        +
                                                                        +

                                                                        Parameters

                                                                        +
                                                                          +
                                                                        • +
                                                                          elementName: string
                                                                          +
                                                                          +

                                                                          The internal element name, previously used to + register the element with the private registry.

                                                                          +
                                                                          +
                                                                          • +
                                                                        +

                                                                        Returns null | Registration

                                                                        +

                                                                        The element data in the registry, or null if there is + no such element name registered.

                                                                        +
                                                                        • +
                                                                      +
                                                                      +
                                                                      + +

                                                                      pluginPolyfill

                                                                      +
                                                                        +
                                                                      • pluginPolyfill(): void
                                                                        • +
                                                                      + +
                                                                      +
                                                                      + +

                                                                      polyfill

                                                                      +
                                                                        +
                                                                      • polyfill(isExt: boolean): void
                                                                        • +
                                                                      +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Polyfills legacy Flash content on the page.

                                                                        +
                                                                        +
                                                                        +

                                                                        Parameters

                                                                        +
                                                                          +
                                                                        • +
                                                                          isExt: boolean
                                                                          +
                                                                          +

                                                                          Whether or not Ruffle is running as a browser's extension.

                                                                          +
                                                                          +
                                                                          • +
                                                                        +

                                                                        Returns void

                                                                        +
                                                                        • +
                                                                      +
                                                                      +
                                                                      + +

                                                                      publicPath

                                                                      +
                                                                        +
                                                                      • publicPath(config: Config, source_name: string): string
                                                                        • +
                                                                      +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Attempt to discover the public path of the current Ruffle source. This can + be used to configure Webpack.

                                                                        +
                                                                        +

                                                                        We have several points of configuration for how the Ruffle public path can + be determined:

                                                                        +
                                                                          +
                                                                        1. The public path can be specified on a per-source basis using the + RufflePlayer config, for example: + window.RufflePlayer.config.publicPaths.local = "/dist/";
                                                                          2. +
                                                                        2. A global public path can be specified for all sources, also in config. + window.RufflePlayer.config.publicPath = "/dist/";
                                                                          3. +
                                                                        3. If there is absolutely no configuration that yields a public path then we + return the parent path of where this script is hosted, which should be + the correct default in most cases.
                                                                          4. +
                                                                        +
                                                                        +

                                                                        Parameters

                                                                        +
                                                                          +
                                                                        • +
                                                                          config: Config
                                                                          +
                                                                          +

                                                                          The window.RufflePlayer.config object.

                                                                          +
                                                                          +
                                                                          • +
                                                                        • +
                                                                          source_name: string
                                                                          +
                                                                          +

                                                                          The name of the source.

                                                                          +
                                                                          +
                                                                          • +
                                                                        +

                                                                        Returns string

                                                                        +

                                                                        The public path for the given source.

                                                                        +
                                                                        • +
                                                                      +
                                                                      +
                                                                      + +

                                                                      registerElement

                                                                      +
                                                                        +
                                                                      • registerElement(elementName: string, elementClass: CustomElementConstructor): string
                                                                        • +
                                                                      +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Register a custom element.

                                                                        +
                                                                        +

                                                                        This function is designed to be tolerant of naming conflicts. If + registration fails, we modify the name, and try again. As a result, this + function returns the real element name to use.

                                                                        +

                                                                        Calling this function multiple times will not register multiple elements. + We store a private registry mapping internal element names to DOM names. + Thus, the proper way to use this function is to call it every time you are + about to work with custom element names.

                                                                        +
                                                                        +
                                                                        throws
                                                                        +

                                                                        Throws an error if two different elements were registered with the + same internal name.

                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Parameters

                                                                        +
                                                                          +
                                                                        • +
                                                                          elementName: string
                                                                          +
                                                                          +

                                                                          The internal name of the element.

                                                                          +
                                                                          +
                                                                          • +
                                                                        • +
                                                                          elementClass: CustomElementConstructor
                                                                          +
                                                                          +

                                                                          The class of the element.

                                                                          +

                                                                          You must call this function with the same class every time.

                                                                          +
                                                                          +
                                                                          • +
                                                                        +

                                                                        Returns string

                                                                        +

                                                                        The actual element name.

                                                                        +
                                                                        • +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Legend

                                                                      +
                                                                      +
                                                                        +
                                                                      • Constructor
                                                                        • +
                                                                      • Property
                                                                        • +
                                                                      • Method
                                                                        • +
                                                                      +
                                                                        +
                                                                      • Inherited constructor
                                                                        • +
                                                                      • Inherited property
                                                                        • +
                                                                      • Inherited method
                                                                        • +
                                                                      +
                                                                        +
                                                                      • Property
                                                                        • +
                                                                      +
                                                                        +
                                                                      • Static method
                                                                        • +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Generated using TypeDoc

                                                                      +
                                                                      +
                                                                      + + + \ No newline at end of file diff --git a/master/modules/Config.html b/master/modules/Config.html deleted file mode 100644 index 2c8ab1c53..000000000 --- a/master/modules/Config.html +++ /dev/null @@ -1,4 +0,0 @@ -Config | ruffle-core
                                                                      ruffle-core
                                                                        Preparing search index...

                                                                        Namespace Config

                                                                        The Config module contains all the types that Ruffle uses for movie configs.

                                                                        -

                                                                        The main interface of interest here is BaseLoadOptions, which you can apply to window.RufflePlayer.config -to set the default configuration of all players.

                                                                        -

                                                                        Enumerations

                                                                        AutoPlay
                                                                        Letterbox
                                                                        UnmuteOverlay
                                                                        LogLevel
                                                                        WindowMode
                                                                        RenderBackend
                                                                        ContextMenu
                                                                        PlayerRuntime
                                                                        OpenURLMode
                                                                        NetworkingAccessMode
                                                                        ScrollingBehavior
                                                                        GamepadButton

                                                                        Interfaces

                                                                        ObsoleteDuration
                                                                        SocketProxy
                                                                        DefaultFonts
                                                                        BaseLoadOptions
                                                                        URLLoadOptions
                                                                        DataLoadOptions

                                                                        Type Aliases

                                                                        SecsDuration
                                                                        Duration

                                                                        Variables

                                                                        DEFAULT_CONFIG

                                                                        Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        Enumerations
                                                                        Interfaces
                                                                        Type Aliases
                                                                        Variables
                                                                        diff --git a/master/modules/Player.html b/master/modules/Player.html deleted file mode 100644 index 85f1a1446..000000000 --- a/master/modules/Player.html +++ /dev/null @@ -1,2 +0,0 @@ -Player | ruffle-core
                                                                        ruffle-core
                                                                          Preparing search index...

                                                                          Namespace Player

                                                                          The Player module contains the actual PlayerElement and the various interfaces that exist to interact with the player.

                                                                          -

                                                                          Enumerations

                                                                          ReadyState

                                                                          Interfaces

                                                                          FlashAPI
                                                                          PlayerElement
                                                                          MovieMetadata
                                                                          LegacyRuffleAPI
                                                                          PlayerV1

                                                                          Type Aliases

                                                                          APIVersions

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Enumerations
                                                                          Interfaces
                                                                          Type Aliases
                                                                          diff --git a/master/modules/Setup.html b/master/modules/Setup.html deleted file mode 100644 index 5419d82a3..000000000 --- a/master/modules/Setup.html +++ /dev/null @@ -1,10 +0,0 @@ -Setup | ruffle-core
                                                                          ruffle-core
                                                                            Preparing search index...

                                                                            Namespace Setup

                                                                            The Setup module contains the interfaces and methods needed to install Ruffle onto a page, -and create a Player.PlayerElement with the latest version of Ruffle available.

                                                                            -

                                                                            This is primarily relevant to users of ruffle-core as a npm module, as the "selfhosted" version of Ruffle preinstalls itself, -and without type checking the interfaces here are of limited use.

                                                                            -

                                                                            For users of ruffle-core as a npm module, you are encouraged to call installRuffle once during page load to -make the ruffle-core library register itself as a version of Ruffle on the page.

                                                                            -

                                                                            Multiple sources of Ruffle may exist - for example, the Ruffle browser extension also installs itself on page load. -For this reason, you are required to call window.RufflePlayer.newest() (for example) to grab the latest SourceAPI, -from which you can create a Player.PlayerElement via SourceAPI.createPlayer.

                                                                            -

                                                                            Classes

                                                                            PublicAPI

                                                                            Interfaces

                                                                            PublicAPILike
                                                                            SourceAPI
                                                                            InstallationOptions

                                                                            Functions

                                                                            installRuffle

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Classes
                                                                            Interfaces
                                                                            Functions
                                                                            diff --git a/master/types/Config.Duration.html b/master/types/Config.Duration.html deleted file mode 100644 index e8b3bcb94..000000000 --- a/master/types/Config.Duration.html +++ /dev/null @@ -1,3 +0,0 @@ -Duration | ruffle-core
                                                                            ruffle-core
                                                                              Preparing search index...

                                                                              Type Alias Duration

                                                                              Duration: SecsDuration | ObsoleteDuration

                                                                              Any new duration-based setting should use 'number' or 'SecsDuration' for its type, -instead of this type.

                                                                              -

                                                                              Settings

                                                                              Member Visibility
                                                                              diff --git a/master/types/Config.SecsDuration.html b/master/types/Config.SecsDuration.html deleted file mode 100644 index 32bed03ee..000000000 --- a/master/types/Config.SecsDuration.html +++ /dev/null @@ -1,2 +0,0 @@ -SecsDuration | ruffle-core
                                                                              ruffle-core
                                                                                Preparing search index...

                                                                                Type Alias SecsDuration

                                                                                SecsDuration: number

                                                                                Non-negative duration in seconds.

                                                                                -

                                                                                Settings

                                                                                Member Visibility
                                                                                diff --git a/master/types/Player.APIVersions.html b/master/types/Player.APIVersions.html deleted file mode 100644 index a7ae552cd..000000000 --- a/master/types/Player.APIVersions.html +++ /dev/null @@ -1,3 +0,0 @@ -APIVersions | ruffle-core
                                                                                ruffle-core
                                                                                  Preparing search index...

                                                                                  Type Alias APIVersions

                                                                                  A map of API version number, to API interface.

                                                                                  -
                                                                                  type APIVersions = {
                                                                                      "1": PlayerV1;
                                                                                  }
                                                                                  Index

                                                                                  Properties

                                                                                  1 -

                                                                                  Properties

                                                                                  "1": PlayerV1

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Properties
                                                                                  diff --git a/master/variables/Config.DEFAULT_CONFIG.html b/master/variables/Config.DEFAULT_CONFIG.html deleted file mode 100644 index 234f7e753..000000000 --- a/master/variables/Config.DEFAULT_CONFIG.html +++ /dev/null @@ -1 +0,0 @@ -DEFAULT_CONFIG | ruffle-core
                                                                                  ruffle-core
                                                                                    Preparing search index...

                                                                                    Variable DEFAULT_CONFIGConst

                                                                                    DEFAULT_CONFIG: Required<BaseLoadOptions> = ...

                                                                                    Settings

                                                                                    Member Visibility
                                                                                    diff --git a/master/variables/buildInfo.html b/master/variables/buildInfo.html deleted file mode 100644 index 14276237e..000000000 --- a/master/variables/buildInfo.html +++ /dev/null @@ -1,3 +0,0 @@ -buildInfo | ruffle-core
                                                                                    ruffle-core
                                                                                      Preparing search index...

                                                                                      Variable buildInfoConst

                                                                                      buildInfo: {
                                                                                          versionNumber: string;
                                                                                          versionName: string;
                                                                                          versionChannel: string;
                                                                                          buildDate: string;
                                                                                          commitHash: string;
                                                                                      } = ...

                                                                                      Stores build information about this specific version of the ruffle-core library.

                                                                                      -

                                                                                      It does not represent the version of Ruffle that may be in use by the page (for example, if a browser extension overrides it).

                                                                                      -

                                                                                      Type Declaration

                                                                                      • versionNumber: string
                                                                                      • versionName: string
                                                                                      • versionChannel: string
                                                                                      • buildDate: string
                                                                                      • commitHash: string

                                                                                      Settings

                                                                                      Member Visibility
                                                                                      diff --git a/master/variables/currentScriptURL.html b/master/variables/currentScriptURL.html deleted file mode 100644 index 98b1e8a50..000000000 --- a/master/variables/currentScriptURL.html +++ /dev/null @@ -1 +0,0 @@ -currentScriptURL | ruffle-core
                                                                                      ruffle-core
                                                                                        Preparing search index...

                                                                                        Variable currentScriptURL

                                                                                        currentScriptURL: URL | null = null

                                                                                        Settings

                                                                                        Member Visibility
                                                                                        diff --git a/master/variables/isExtension.html b/master/variables/isExtension.html deleted file mode 100644 index 45546a7b8..000000000 --- a/master/variables/isExtension.html +++ /dev/null @@ -1 +0,0 @@ -isExtension | ruffle-core
                                                                                        ruffle-core
                                                                                          Preparing search index...

                                                                                          Variable isExtension

                                                                                          isExtension: boolean = false

                                                                                          Settings

                                                                                          Member Visibility