bitmovin-player-ui 4.2.0 → 4.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +20 -0
- package/dist/js/bitmovinplayer-ui.js +1 -1
- package/dist/js/bitmovinplayer-ui.js.map +1 -1
- package/dist/js/framework/UIFactory.js +1 -2
- package/dist/js/framework/components/Container.d.ts +1 -1
- package/dist/js/framework/components/UIContainer.d.ts +7 -1
- package/dist/js/framework/components/UIContainer.js +33 -2
- package/dist/js/framework/components/ads/AdMessageLabel.d.ts +22 -3
- package/dist/js/framework/components/ads/AdMessageLabel.js +40 -17
- package/dist/js/framework/components/overlays/DismissClickOverlay.js +7 -1
- package/dist/js/framework/components/settings/SettingsPanel.d.ts +28 -1
- package/dist/js/framework/components/settings/SettingsPanel.js +103 -7
- package/dist/js/framework/utils/StringUtils.d.ts +2 -2
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/AdClickOverlay.html +28 -28
- package/docs/classes/AdControlBar.html +31 -31
- package/docs/classes/AdCounterLabel.html +31 -31
- package/docs/classes/AdMessageLabel.html +51 -32
- package/docs/classes/AdSkipButton.html +27 -27
- package/docs/classes/AdStatusOverlay.html +31 -31
- package/docs/classes/AirPlayToggleButton.html +35 -35
- package/docs/classes/AudioQualitySelectBox.html +38 -38
- package/docs/classes/AudioTrackListBox.html +40 -39
- package/docs/classes/AudioTrackSelectBox.html +38 -38
- package/docs/classes/BackgroundColorSelectBox.html +38 -38
- package/docs/classes/BackgroundOpacitySelectBox.html +38 -38
- package/docs/classes/BrowserUtils.html +2 -2
- package/docs/classes/BufferingOverlay.html +31 -31
- package/docs/classes/Button.html +27 -27
- package/docs/classes/CastStatusOverlay.html +31 -31
- package/docs/classes/CastToggleButton.html +35 -35
- package/docs/classes/CastUIContainer.html +31 -31
- package/docs/classes/CharacterEdgeSelectBox.html +38 -38
- package/docs/classes/ClickOverlay.html +28 -28
- package/docs/classes/CloseButton.html +27 -27
- package/docs/classes/Component.html +25 -25
- package/docs/classes/Container.html +31 -31
- package/docs/classes/ControlBar.html +31 -31
- package/docs/classes/DynamicSettingsPanelItem.html +33 -33
- package/docs/classes/ErrorMessageOverlay.html +31 -31
- package/docs/classes/FontColorSelectBox.html +38 -38
- package/docs/classes/FontFamilySelectBox.html +38 -38
- package/docs/classes/FontOpacitySelectBox.html +38 -38
- package/docs/classes/FontSizeSelectBox.html +38 -38
- package/docs/classes/FullscreenToggleButton.html +35 -35
- package/docs/classes/HugePlaybackToggleButton.html +35 -35
- package/docs/classes/HugeReplayButton.html +27 -27
- package/docs/classes/I18n.html +2 -2
- package/docs/classes/Icon.html +25 -25
- package/docs/classes/ItemSelectionList.html +38 -38
- package/docs/classes/Label.html +31 -31
- package/docs/classes/ListBox.html +40 -39
- package/docs/classes/ListSelector.html +38 -38
- package/docs/classes/MetadataLabel.html +31 -31
- package/docs/classes/NavigationGroup.html +10 -10
- package/docs/classes/PictureInPictureToggleButton.html +35 -35
- package/docs/classes/PlaybackSpeedSelectBox.html +38 -38
- package/docs/classes/PlaybackTimeLabel.html +32 -32
- package/docs/classes/PlaybackToggleButton.html +35 -35
- package/docs/classes/PlaybackToggleOverlay.html +31 -31
- package/docs/classes/PlayerUtils.LiveStreamDetector.html +2 -2
- package/docs/classes/PlayerUtils.TimeShiftAvailabilityDetector.html +2 -2
- package/docs/classes/PlayerWrapper.html +4 -4
- package/docs/classes/QuickSeekButton.html +27 -27
- package/docs/classes/RecommendationItem.html +25 -25
- package/docs/classes/RecommendationOverlay.html +31 -31
- package/docs/classes/ReplayButton.html +27 -27
- package/docs/classes/RootNavigationGroup.html +10 -10
- package/docs/classes/SeekBar.html +36 -36
- package/docs/classes/SeekBarLabel.html +35 -35
- package/docs/classes/SelectBox.html +38 -38
- package/docs/classes/SettingsPanel.html +40 -39
- package/docs/classes/SettingsPanelItem.html +33 -33
- package/docs/classes/SettingsPanelNavigationGroup.html +10 -10
- package/docs/classes/SettingsPanelNavigationGroupConfig.html +2 -2
- package/docs/classes/SettingsPanelPage.html +33 -33
- package/docs/classes/SettingsPanelPageBackButton.html +29 -29
- package/docs/classes/SettingsPanelPageOpenButton.html +29 -29
- package/docs/classes/SettingsToggleButton.html +35 -35
- package/docs/classes/Spacer.html +25 -25
- package/docs/classes/SpatialNavigation.html +4 -4
- package/docs/classes/SubtitleListBox.html +40 -39
- package/docs/classes/SubtitleOverlay.html +31 -31
- package/docs/classes/SubtitleSelectBox.html +38 -38
- package/docs/classes/SubtitleSettingSelectBox.html +38 -38
- package/docs/classes/SubtitleSettingsPanelPage.html +33 -33
- package/docs/classes/SubtitleSettingsResetButton.html +27 -27
- package/docs/classes/TitleBar.html +31 -31
- package/docs/classes/ToggleButton.html +35 -35
- package/docs/classes/UIContainer.html +31 -31
- package/docs/classes/UIInstanceManager.html +14 -14
- package/docs/classes/UIManager.html +14 -14
- package/docs/classes/VRToggleButton.html +35 -35
- package/docs/classes/VideoQualitySelectBox.html +39 -39
- package/docs/classes/VolumeControlButton.html +33 -33
- package/docs/classes/VolumeSlider.html +36 -36
- package/docs/classes/VolumeToggleButton.html +35 -35
- package/docs/classes/Watermark.html +28 -28
- package/docs/classes/WindowColorSelectBox.html +38 -38
- package/docs/classes/WindowOpacitySelectBox.html +38 -38
- package/docs/enums/ButtonStyle.html +5 -5
- package/docs/enums/LabelStyle.html +4 -4
- package/docs/enums/MetadataLabelContent.html +3 -3
- package/docs/enums/NavigationDirection.html +2 -2
- package/docs/enums/PlaybackTimeLabelMode.html +5 -5
- package/docs/enums/PlayerUtils.PlayerState.html +2 -2
- package/docs/enums/UIUtils.KeyCode.html +2 -2
- package/docs/enums/ViewMode.html +3 -3
- package/docs/functions/ArrayUtils.remove.html +1 -1
- package/docs/functions/ErrorUtils.defaultMobileV3ErrorMessageTranslator.html +1 -1
- package/docs/functions/PlayerUtils.clampValueToRange.html +1 -1
- package/docs/functions/PlayerUtils.getCurrentTimeRelativeToSeekableRange.html +1 -1
- package/docs/functions/PlayerUtils.getSeekableRangeRespectingLive.html +1 -1
- package/docs/functions/PlayerUtils.getSeekableRangeStart.html +1 -1
- package/docs/functions/PlayerUtils.getState.html +1 -1
- package/docs/functions/PlayerUtils.isTimeShiftAvailable.html +1 -1
- package/docs/functions/StorageUtils.getItem.html +1 -1
- package/docs/functions/StorageUtils.getObject.html +1 -1
- package/docs/functions/StorageUtils.setItem.html +1 -1
- package/docs/functions/StorageUtils.setObject.html +1 -1
- package/docs/functions/StorageUtils.setStorageApiDisabled.html +1 -1
- package/docs/functions/StringUtils.replaceAdMessagePlaceholders.html +1 -1
- package/docs/functions/StringUtils.secondsToText.html +1 -1
- package/docs/functions/StringUtils.secondsToTime.html +1 -1
- package/docs/functions/UIFactory.buildCastReceiverUI.html +1 -1
- package/docs/functions/UIFactory.buildSmallScreenUI.html +1 -1
- package/docs/functions/UIFactory.buildSubtitleUI.html +1 -1
- package/docs/functions/UIFactory.buildTvUI.html +1 -1
- package/docs/functions/UIFactory.buildUI.html +1 -1
- package/docs/functions/UIUtils.traverseTree.html +1 -1
- package/docs/hierarchy.html +1 -1
- package/docs/interfaces/ActiveUiChangedArgs.html +3 -3
- package/docs/interfaces/AdControlBarConfig.html +12 -12
- package/docs/interfaces/AdSkipButtonConfig.html +16 -16
- package/docs/interfaces/BufferingOverlayConfig.html +13 -13
- package/docs/interfaces/ButtonConfig.html +14 -14
- package/docs/interfaces/ClickOverlayConfig.html +15 -15
- package/docs/interfaces/CloseButtonConfig.html +15 -15
- package/docs/interfaces/ComponentConfig.html +11 -11
- package/docs/interfaces/ComponentFocusChangedEventArgs.html +2 -2
- package/docs/interfaces/ComponentHoverChangedEventArgs.html +2 -2
- package/docs/interfaces/ContainerConfig.html +12 -12
- package/docs/interfaces/ControlBarConfig.html +12 -12
- package/docs/interfaces/DynamicSettingsPanelItemConfig.html +19 -19
- package/docs/interfaces/ErrorMessageMap.html +1 -1
- package/docs/interfaces/ErrorMessageOverlayConfig.html +13 -13
- package/docs/interfaces/ErrorMessageTranslator.html +1 -1
- package/docs/interfaces/ExternalRecommendationLink.html +3 -3
- package/docs/interfaces/IconConfig.html +12 -12
- package/docs/interfaces/InternalUIConfig.html +15 -15
- package/docs/interfaces/LabelConfig.html +14 -14
- package/docs/interfaces/ListBoxConfig.html +22 -17
- package/docs/interfaces/ListItem.html +2 -2
- package/docs/interfaces/ListItemFilter.html +1 -1
- package/docs/interfaces/ListItemLabelTranslator.html +1 -1
- package/docs/interfaces/ListSelectorConfig.html +11 -11
- package/docs/interfaces/LocalizationConfig.html +3 -3
- package/docs/interfaces/MetadataLabelConfig.html +15 -15
- package/docs/interfaces/PlaybackTimeLabelConfig.html +16 -16
- package/docs/interfaces/PlaybackToggleButtonConfig.html +19 -19
- package/docs/interfaces/PlaybackToggleOverlayConfig.html +13 -13
- package/docs/interfaces/PlayerUtils.LiveStreamDetectorEventArgs.html +2 -2
- package/docs/interfaces/PlayerUtils.TimeShiftAvailabilityChangedArgs.html +2 -2
- package/docs/interfaces/QuickSeekButtonConfig.html +15 -15
- package/docs/interfaces/RecommendationConfig.html +4 -4
- package/docs/interfaces/RecommendationItemConfig.html +12 -12
- package/docs/interfaces/SeekBarConfig.html +19 -19
- package/docs/interfaces/SeekBarLabelConfig.html +12 -12
- package/docs/interfaces/SeekBarMarker.html +2 -2
- package/docs/interfaces/SeekPreviewArgs.html +3 -3
- package/docs/interfaces/SeekPreviewEventArgs.html +4 -4
- package/docs/interfaces/SettingsPanelConfig.html +20 -15
- package/docs/interfaces/SettingsPanelItemConfig.html +17 -17
- package/docs/interfaces/SettingsPanelPageConfig.html +13 -13
- package/docs/interfaces/SettingsToggleButtonConfig.html +20 -20
- package/docs/interfaces/SubtitleSettingSelectBoxConfig.html +11 -11
- package/docs/interfaces/SubtitleSettingsPanelPageConfig.html +13 -13
- package/docs/interfaces/TimelineMarker.html +6 -6
- package/docs/interfaces/TitleBarConfig.html +13 -13
- package/docs/interfaces/ToggleButtonConfig.html +18 -18
- package/docs/interfaces/UIConditionContext.html +10 -10
- package/docs/interfaces/UIConditionResolver.html +1 -1
- package/docs/interfaces/UIConfig.html +14 -14
- package/docs/interfaces/UIContainerConfig.html +20 -16
- package/docs/interfaces/UIUtils.TreeTraversalCallback.html +1 -1
- package/docs/interfaces/UIVariant.html +2 -2
- package/docs/interfaces/ViewModeChangedEventArgs.html +2 -2
- package/docs/interfaces/Vocabularies.html +1 -1
- package/docs/interfaces/Vocabulary.html +2 -2
- package/docs/interfaces/VolumeControlButtonConfig.html +14 -14
- package/docs/interfaces/VolumeSliderConfig.html +21 -21
- package/docs/interfaces/WatermarkConfig.html +15 -15
- package/docs/interfaces/WrappedPlayer.html +2 -2
- package/docs/media/CHANGELOG.md +20 -0
- package/docs/types/CustomVocabulary.html +1 -1
- package/docs/types/LocalizableText.html +1 -1
- package/docs/types/Localizer.html +1 -1
- package/docs/variables/ErrorUtils.defaultErrorMessages.html +1 -1
- package/docs/variables/ErrorUtils.defaultWebErrorMessageTranslator.html +1 -1
- package/docs/variables/StringUtils.FORMAT_HHMMSS.html +1 -1
- package/docs/variables/StringUtils.FORMAT_MMSS.html +1 -1
- package/docs/variables/i18n.html +1 -1
- package/docs/variables/version.html +1 -1
- package/package.json +1 -1
- package/src/ts/DOM.ts +18 -18
- package/src/ts/EventDispatcher.ts +5 -5
- package/src/ts/UIFactory.ts +8 -9
- package/src/ts/UIManager.ts +29 -29
- package/src/ts/components/CastUIContainer.ts +6 -6
- package/src/ts/components/Component.ts +3 -3
- package/src/ts/components/Container.ts +5 -5
- package/src/ts/components/RecommendationItem.ts +2 -2
- package/src/ts/components/TvNoiseCanvas.ts +3 -3
- package/src/ts/components/UIContainer.ts +57 -14
- package/src/ts/components/ads/AdClickOverlay.ts +2 -2
- package/src/ts/components/ads/AdMessageLabel.ts +47 -20
- package/src/ts/components/ads/AdSkipButton.ts +5 -5
- package/src/ts/components/buttons/Button.ts +1 -1
- package/src/ts/components/buttons/CastToggleButton.ts +1 -1
- package/src/ts/components/buttons/CloseButton.ts +1 -1
- package/src/ts/components/buttons/HugePlaybackToggleButton.ts +3 -3
- package/src/ts/components/buttons/PlaybackToggleButton.ts +3 -3
- package/src/ts/components/buttons/QuickSeekButton.ts +1 -1
- package/src/ts/components/buttons/SmallCenteredPlaybackToggleButton.ts +1 -1
- package/src/ts/components/buttons/VRToggleButton.ts +4 -4
- package/src/ts/components/buttons/VolumeControlButton.ts +2 -2
- package/src/ts/components/labels/Label.ts +1 -1
- package/src/ts/components/labels/MetadataLabel.ts +4 -4
- package/src/ts/components/labels/PlaybackTimeLabel.ts +13 -13
- package/src/ts/components/lists/ItemSelectionList.ts +3 -3
- package/src/ts/components/lists/ListSelector.ts +4 -4
- package/src/ts/components/overlays/CastStatusOverlay.ts +2 -2
- package/src/ts/components/overlays/ClickOverlay.ts +1 -1
- package/src/ts/components/overlays/DismissClickOverlay.ts +7 -2
- package/src/ts/components/overlays/ErrorMessageOverlay.ts +2 -2
- package/src/ts/components/overlays/RecommendationOverlay.ts +2 -2
- package/src/ts/components/overlays/SubtitleOverlay.ts +10 -10
- package/src/ts/components/seekbar/SeekBar.ts +37 -37
- package/src/ts/components/seekbar/SeekBarLabel.ts +15 -15
- package/src/ts/components/seekbar/VolumeSlider.ts +1 -1
- package/src/ts/components/settings/AudioQualitySelectBox.ts +4 -4
- package/src/ts/components/settings/DynamicSettingsPanelItem.ts +3 -3
- package/src/ts/components/settings/SelectBox.ts +3 -3
- package/src/ts/components/settings/SettingsPanel.ts +137 -10
- package/src/ts/components/settings/SettingsPanelItem.ts +1 -1
- package/src/ts/components/settings/SettingsPanelPage.ts +4 -4
- package/src/ts/components/settings/SettingsPanelSelectOption.ts +1 -1
- package/src/ts/components/settings/SettingsToggleButton.ts +3 -3
- package/src/ts/components/settings/VideoQualitySelectBox.ts +4 -4
- package/src/ts/components/settings/subtitlesettings/BackgroundColorSelectBox.ts +1 -1
- package/src/ts/components/settings/subtitlesettings/FontColorSelectBox.ts +1 -1
- package/src/ts/components/settings/subtitlesettings/WindowColorSelectBox.ts +1 -1
- package/src/ts/main.ts +2 -2
- package/src/ts/spatialnavigation/NavigationGroup.ts +2 -2
- package/src/ts/spatialnavigation/SettingsPanelNavigationGroup.ts +1 -1
- package/src/ts/utils/ArrayUtils.ts +1 -1
- package/src/ts/utils/AudioTrackUtils.ts +1 -1
- package/src/ts/utils/ImageLoader.ts +2 -2
- package/src/ts/utils/PlayerUtils.ts +4 -4
- package/src/ts/utils/StorageUtils.ts +3 -3
- package/src/ts/utils/StringUtils.ts +17 -17
- package/src/ts/utils/SubtitleSettingsManager.ts +3 -3
- package/src/ts/utils/SubtitleUtils.ts +1 -1
- package/src/ts/utils/UIUtils.ts +2 -2
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DynamicSettingsPanelItem | bitmovin-player-ui</title><meta name="description" content="Documentation for bitmovin-player-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">bitmovin-player-ui</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">DynamicSettingsPanelItem</a></li></ul><h1>Class DynamicSettingsPanelItem</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A dynamic settings panel item which can build a sub page with the items of a <a href="ListSelector.html" class="tsd-kind-class">ListSelector</a>.
|
|
2
2
|
The page will be dynamically added and removed from the <a href="SettingsPanel.html" class="tsd-kind-class">SettingsPanel</a>.</p>
|
|
3
|
-
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
3
|
+
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="10182"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">InteractiveSettingsPanelItem</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DynamicSettingsPanelItemConfig.html" class="tsd-signature-type tsd-kind-interface">DynamicSettingsPanelItemConfig</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">DynamicSettingsPanelItem</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/settings/DynamicSettingsPanelItem.ts#L46">src/ts/components/settings/DynamicSettingsPanelItem.ts:46</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
4
4
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#onactivechanged" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Active<wbr/>Changed</span></a>
|
|
5
5
|
<a href="#onclick" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Click</span></a>
|
|
6
6
|
<a href="#ondisabled" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Disabled</span></a>
|
|
@@ -36,66 +36,66 @@ The page will be dynamically added and removed from the <a href="SettingsPanel.h
|
|
|
36
36
|
<a href="#show" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show</span></a>
|
|
37
37
|
<a href="#togglehidden" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Hidden</span></a>
|
|
38
38
|
<a href="#updatecomponents" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Components</span></a>
|
|
39
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordynamicsettingspanelitem"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DynamicSettingsPanelItem</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DynamicSettingsPanelItemConfig.html" class="tsd-signature-type tsd-kind-interface">DynamicSettingsPanelItemConfig</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DynamicSettingsPanelItem</a><a href="#constructordynamicsettingspanelitem" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <a href="../interfaces/DynamicSettingsPanelItemConfig.html" class="tsd-signature-type tsd-kind-interface">DynamicSettingsPanelItemConfig</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DynamicSettingsPanelItem</a></h4><aside class="tsd-sources"><p>Overrides InteractiveSettingsPanelItem<DynamicSettingsPanelItemConfig>.constructor</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
39
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordynamicsettingspanelitem"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DynamicSettingsPanelItem</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DynamicSettingsPanelItemConfig.html" class="tsd-signature-type tsd-kind-interface">DynamicSettingsPanelItemConfig</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DynamicSettingsPanelItem</a><a href="#constructordynamicsettingspanelitem" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <a href="../interfaces/DynamicSettingsPanelItemConfig.html" class="tsd-signature-type tsd-kind-interface">DynamicSettingsPanelItemConfig</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DynamicSettingsPanelItem</a></h4><aside class="tsd-sources"><p>Overrides InteractiveSettingsPanelItem<DynamicSettingsPanelItemConfig>.constructor</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/settings/DynamicSettingsPanelItem.ts#L54">src/ts/components/settings/DynamicSettingsPanelItem.ts:54</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onactivechanged"><span>on<wbr/>Active<wbr/>Changed</span><a href="#onactivechanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="onactivechangedonactivechanged"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onActiveChanged</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="SettingsPanelItem.html" class="tsd-signature-type tsd-kind-class">SettingsPanelItem</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="SettingsPanelItem.html#constructorsettingspanelitemconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the 'active' state of this item changes.</p>
|
|
40
40
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="SettingsPanelItem.html" class="tsd-signature-type tsd-kind-class">SettingsPanelItem</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="SettingsPanelItem.html#constructorsettingspanelitemconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>#isActive</p>
|
|
41
|
-
</div></div><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onActiveChanged</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
42
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InteractiveSettingsPanelItem</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Config</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onClick</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
41
|
+
</div></div><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onActiveChanged</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/settings/SettingsPanelItem.ts#L159">src/ts/components/settings/SettingsPanelItem.ts:159</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onclick"><span>on<wbr/>Click</span><a href="#onclick" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="onclickonclick"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onClick</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InteractiveSettingsPanelItem</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Config</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the SettingsPanelItem is clicked.</p>
|
|
42
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InteractiveSettingsPanelItem</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Config</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onClick</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/settings/InteractiveSettingsPanelItem.ts#L62">src/ts/components/settings/InteractiveSettingsPanelItem.ts:62</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ondisabled"><span>on<wbr/>Disabled</span><a href="#ondisabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="ondisabledondisabled"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onDisabled</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the component is disabling.
|
|
43
43
|
See the detailed explanation on event architecture on the #componentEvents events list.</p>
|
|
44
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onDisabled</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
44
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onDisabled</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L594">src/ts/components/Component.ts:594</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onenabled"><span>on<wbr/>Enabled</span><a href="#onenabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="onenabledonenabled"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onEnabled</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the component is enabling.
|
|
45
45
|
See the detailed explanation on event architecture on the #componentEvents events list.</p>
|
|
46
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onEnabled</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
47
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ComponentFocusChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ComponentFocusChangedEventArgs</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onFocusedChanged</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
46
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onEnabled</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L585">src/ts/components/Component.ts:585</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onfocusedchanged"><span>on<wbr/>Focused<wbr/>Changed</span><a href="#onfocusedchanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="onfocusedchangedonfocusedchanged"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onFocusedChanged</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ComponentFocusChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ComponentFocusChangedEventArgs</a><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the component's focus-state is changing.</p>
|
|
47
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ComponentFocusChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ComponentFocusChangedEventArgs</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onFocusedChanged</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L618">src/ts/components/Component.ts:618</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onhide"><span>on<wbr/>Hide</span><a href="#onhide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="onhideonhide"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onHide</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the component is hiding.
|
|
48
48
|
See the detailed explanation on event architecture on the #componentEvents events list.</p>
|
|
49
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onHide</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
50
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ComponentHoverChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ComponentHoverChangedEventArgs</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onHoverChanged</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
49
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onHide</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L576">src/ts/components/Component.ts:576</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onhoverchanged"><span>on<wbr/>Hover<wbr/>Changed</span><a href="#onhoverchanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="onhoverchangedonhoverchanged"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onHoverChanged</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ComponentHoverChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ComponentHoverChangedEventArgs</a><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the component's hover-state is changing.</p>
|
|
50
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ComponentHoverChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ComponentHoverChangedEventArgs</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onHoverChanged</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L602">src/ts/components/Component.ts:602</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onshow"><span>on<wbr/>Show</span><a href="#onshow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="onshowonshow"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onShow</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the component is showing.
|
|
51
51
|
See the detailed explanation on event architecture on the #componentEvents events list.</p>
|
|
52
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onShow</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
53
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ViewModeChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ViewModeChangedEventArgs</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onViewModeChanged</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
52
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">NoArgs</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onShow</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L567">src/ts/components/Component.ts:567</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onviewmodechanged"><span>on<wbr/>View<wbr/>Mode<wbr/>Changed</span><a href="#onviewmodechanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="onviewmodechangedonviewmodechanged"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">onViewModeChanged</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ViewModeChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ViewModeChangedEventArgs</a><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the event that is fired when the <code>ViewMode</code> of this component has changed.</p>
|
|
53
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Component.html#constructorcomponentconfig">Config</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <a href="../interfaces/ViewModeChangedEventArgs.html" class="tsd-signature-type tsd-kind-interface">ViewModeChangedEventArgs</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.onViewModeChanged</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L610">src/ts/components/Component.ts:610</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="addcomponent"><span>add<wbr/>Component</span><a href="#addcomponent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="addcomponent-1"><span class="tsd-kind-call-signature">addComponent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">component</span><span class="tsd-signature-symbol">:</span> <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addcomponent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a child component to the container.</p>
|
|
54
54
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">component</span>: <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>the component to add</p>
|
|
55
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.addComponent</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
55
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.addComponent</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Container.ts#L71">src/ts/components/Container.ts:71</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="configure"><span>configure</span><a href="#configure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="configure-1"><span class="tsd-kind-call-signature">configure</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">player</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlayerAPI</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">uimanager</span><span class="tsd-signature-symbol">:</span> <a href="UIInstanceManager.html" class="tsd-signature-type tsd-kind-class">UIInstanceManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#configure-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">player</span>: <span class="tsd-signature-type">PlayerAPI</span></span></li><li><span><span class="tsd-kind-parameter">uimanager</span>: <a href="UIInstanceManager.html" class="tsd-signature-type tsd-kind-class">UIInstanceManager</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides InteractiveSettingsPanelItem.configure</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/settings/DynamicSettingsPanelItem.ts#L80">src/ts/components/settings/DynamicSettingsPanelItem.ts:80</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="disable"><span>disable</span><a href="#disable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="disable-1"><span class="tsd-kind-call-signature">disable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#disable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Disables the component.
|
|
56
56
|
This method basically transfers the component into the disabled state. Actual disabling is done via CSS or child
|
|
57
57
|
components. (e.g. Button needs to unsubscribe click listeners)</p>
|
|
58
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.disable</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
58
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.disable</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L459">src/ts/components/Component.ts:459</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="displayitemssubpage"><span>display<wbr/>Items<wbr/>Sub<wbr/>Page</span><a href="#displayitemssubpage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="displayitemssubpage-1"><span class="tsd-kind-call-signature">displayItemsSubPage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#displayitemssubpage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/settings/DynamicSettingsPanelItem.ts#L166">src/ts/components/settings/DynamicSettingsPanelItem.ts:166</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="enable"><span>enable</span><a href="#enable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="enable-1"><span class="tsd-kind-call-signature">enable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#enable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Enables the component.
|
|
59
59
|
This method basically transfers the component into the enabled state. Actual enabling is done via CSS or child
|
|
60
60
|
components. (e.g. Button needs to subscribe click listeners)</p>
|
|
61
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.enable</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
62
|
-
</div><h4 class="tsd-returns-title">Returns <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.getComponents</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
63
|
-
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/DynamicSettingsPanelItemConfig.html" class="tsd-signature-type tsd-kind-interface">DynamicSettingsPanelItemConfig</a></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.getConfig</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
61
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.enable</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L472">src/ts/components/Component.ts:472</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getcomponents"><span>get<wbr/>Components</span><a href="#getcomponents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getcomponents-1"><span class="tsd-kind-call-signature">getComponents</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><a href="#getcomponents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets an array of all child components in this container.</p>
|
|
62
|
+
</div><h4 class="tsd-returns-title">Returns <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.getComponents</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Container.ts#L103">src/ts/components/Container.ts:103</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getconfig"><span>get<wbr/>Config</span><a href="#getconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getconfig-1"><span class="tsd-kind-call-signature">getConfig</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DynamicSettingsPanelItemConfig.html" class="tsd-signature-type tsd-kind-interface">DynamicSettingsPanelItemConfig</a><a href="#getconfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the configuration object of the component.</p>
|
|
63
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/DynamicSettingsPanelItemConfig.html" class="tsd-signature-type tsd-kind-interface">DynamicSettingsPanelItemConfig</a></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.getConfig</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L400">src/ts/components/Component.ts:400</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getdomelement"><span>get<wbr/>Dom<wbr/>Element</span><a href="#getdomelement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getdomelement-1"><span class="tsd-kind-call-signature">getDomElement</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DOM</span><a href="#getdomelement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the DOM element of this component. Creates the DOM element if it does not yet exist.</p>
|
|
64
64
|
<p>Should not be overwritten by subclasses.</p>
|
|
65
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DOM</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.getDomElement</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
66
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.hasDomElement</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
65
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DOM</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.getDomElement</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L335">src/ts/components/Component.ts:335</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hasdomelement"><span>has<wbr/>Dom<wbr/>Element</span><a href="#hasdomelement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="hasdomelement-1"><span class="tsd-kind-call-signature">hasDomElement</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hasdomelement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if this component has a DOM element.</p>
|
|
66
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.hasDomElement</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L346">src/ts/components/Component.ts:346</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hide"><span>hide</span><a href="#hide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="hide-1"><span class="tsd-kind-call-signature">hide</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#hide-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hides the component if shown.
|
|
67
67
|
This method basically transfers the component into the hidden state. Actual hiding is done via CSS.</p>
|
|
68
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.hide</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
68
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.hide</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L408">src/ts/components/Component.ts:408</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="initialize"><span>initialize</span><a href="#initialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="initialize-1"><span class="tsd-kind-call-signature">initialize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#initialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes the component, e.g. by applying config settings.
|
|
69
69
|
This method must not be called from outside the UI framework.</p>
|
|
70
70
|
<p>This method is automatically called by the <a href="UIInstanceManager.html" class="tsd-kind-class">UIInstanceManager</a>. If the component is an inner component of
|
|
71
71
|
some component, and thus encapsulated abd managed internally and never directly exposed to the UIManager,
|
|
72
72
|
this method must be called from the managing component's #initialize method.</p>
|
|
73
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.initialize</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
73
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.initialize</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L252">src/ts/components/Component.ts:252</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isactive"><span>is<wbr/>Active</span><a href="#isactive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="isactive-1"><span class="tsd-kind-call-signature">isActive</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isactive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if this settings panel item is active, i.e. visible and enabled and a user can interact with it.</p>
|
|
74
74
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the panel is active, else false</p>
|
|
75
|
-
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isActive</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
75
|
+
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isActive</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/settings/SettingsPanelItem.ts#L146">src/ts/components/settings/SettingsPanelItem.ts:146</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isdisabled"><span>is<wbr/>Disabled</span><a href="#isdisabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="isdisabled-1"><span class="tsd-kind-call-signature">isDisabled</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isdisabled-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the component is disabled.</p>
|
|
76
76
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the component is disabled, else false</p>
|
|
77
|
-
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isDisabled</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
77
|
+
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isDisabled</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L484">src/ts/components/Component.ts:484</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isenabled"><span>is<wbr/>Enabled</span><a href="#isenabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="isenabled-1"><span class="tsd-kind-call-signature">isEnabled</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isenabled-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the component is enabled.</p>
|
|
78
78
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the component is enabled, else false</p>
|
|
79
|
-
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isEnabled</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
79
|
+
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isEnabled</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L492">src/ts/components/Component.ts:492</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ishidden"><span>is<wbr/>Hidden</span><a href="#ishidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="ishidden-1"><span class="tsd-kind-call-signature">isHidden</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ishidden-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the component is hidden.</p>
|
|
80
80
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the component is hidden, else false</p>
|
|
81
|
-
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isHidden</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
81
|
+
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isHidden</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L431">src/ts/components/Component.ts:431</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ishovered"><span>is<wbr/>Hovered</span><a href="#ishovered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="ishovered-1"><span class="tsd-kind-call-signature">isHovered</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ishovered-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the component is currently hovered.</p>
|
|
82
82
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the component is hovered, else false</p>
|
|
83
|
-
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isHovered</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
83
|
+
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isHovered</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L500">src/ts/components/Component.ts:500</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isshown"><span>is<wbr/>Shown</span><a href="#isshown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="isshown-1"><span class="tsd-kind-call-signature">isShown</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isshown-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the component is shown.</p>
|
|
84
84
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the component is visible, else false</p>
|
|
85
|
-
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isShown</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
85
|
+
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.isShown</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L439">src/ts/components/Component.ts:439</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="prependcomponent"><span>prepend<wbr/>Component</span><a href="#prependcomponent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="prependcomponent-1"><span class="tsd-kind-call-signature">prependComponent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">component</span><span class="tsd-signature-symbol">:</span> <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#prependcomponent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a child component as the first component in the container.</p>
|
|
86
86
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">component</span>: <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>the component to add</p>
|
|
87
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.prependComponent</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
87
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.prependComponent</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Container.ts#L80">src/ts/components/Container.ts:80</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="release"><span>release</span><a href="#release" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="release-1"><span class="tsd-kind-call-signature">release</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#release-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Releases all resources and dependencies that the component holds. Player, DOM, and UIManager events are
|
|
88
88
|
automatically removed during release and do not explicitly need to be removed here.
|
|
89
89
|
This method is called by the UIManager when it releases the UI.</p>
|
|
90
90
|
<p>Subclasses that need to release resources should override this method and call super.release().</p>
|
|
91
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.release</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
91
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.release</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L301">src/ts/components/Component.ts:301</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="removecomponent"><span>remove<wbr/>Component</span><a href="#removecomponent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="removecomponent-1"><span class="tsd-kind-call-signature">removeComponent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">component</span><span class="tsd-signature-symbol">:</span> <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#removecomponent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes a child component from the container.</p>
|
|
92
92
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">component</span>: <a href="Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>the component to remove</p>
|
|
93
93
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the component has been removed, false if it is not contained in this container</p>
|
|
94
|
-
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.removeComponent</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
95
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.removeComponents</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
96
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.show</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
97
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.toggleHidden</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/
|
|
94
|
+
<aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.removeComponent</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Container.ts#L90">src/ts/components/Container.ts:90</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="removecomponents"><span>remove<wbr/>Components</span><a href="#removecomponents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="removecomponents-1"><span class="tsd-kind-call-signature">removeComponents</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#removecomponents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes all child components from the container.</p>
|
|
95
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.removeComponents</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Container.ts#L110">src/ts/components/Container.ts:110</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setariaattr"><span>set<wbr/>Aria<wbr/>Attr</span><a href="#setariaattr" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="setariaattr-1"><span class="tsd-kind-call-signature">setAriaAttr</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setariaattr-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.setAriaAttr</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L354">src/ts/components/Component.ts:354</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setarialabel"><span>set<wbr/>Aria<wbr/>Label</span><a href="#setarialabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="setarialabel-1"><span class="tsd-kind-call-signature">setAriaLabel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">label</span><span class="tsd-signature-symbol">:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setarialabel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">label</span>: <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.setAriaLabel</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L350">src/ts/components/Component.ts:350</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="show"><span>show</span><a href="#show" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="show-1"><span class="tsd-kind-call-signature">show</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#show-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Shows the component if hidden.</p>
|
|
96
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.show</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L419">src/ts/components/Component.ts:419</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="togglehidden"><span>toggle<wbr/>Hidden</span><a href="#togglehidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="togglehidden-1"><span class="tsd-kind-call-signature">toggleHidden</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#togglehidden-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Toggles the hidden state by hiding the component if it is shown, or showing it if hidden.</p>
|
|
97
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.toggleHidden</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Component.ts#L446">src/ts/components/Component.ts:446</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="updatecomponents"><span>update<wbr/>Components</span><a href="#updatecomponents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="updatecomponents-1"><span class="tsd-kind-call-signature">updateComponents</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatecomponents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the DOM of the container with the current components.</p>
|
|
98
98
|
<p>This is called automatically after construction. However, when you dynamically
|
|
99
99
|
add or remove components at runtime, you must call <code>updateComponents()</code> to
|
|
100
100
|
re-render the container’s children.</p>
|
|
101
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.updateComponents</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/6d702637f4b33f52a26e834207ae63a866465051/src/ts/components/Container.ts#L123">src/ts/components/Container.ts:123</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#onactivechanged" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Active<wbr/>Changed</span></a><a href="#onclick" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Click</span></a><a href="#ondisabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Disabled</span></a><a href="#onenabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Enabled</span></a><a href="#onfocusedchanged" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Focused<wbr/>Changed</span></a><a href="#onhide" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Hide</span></a><a href="#onhoverchanged" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Hover<wbr/>Changed</span></a><a href="#onshow" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Show</span></a><a href="#onviewmodechanged" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>View<wbr/>Mode<wbr/>Changed</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addcomponent" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Component</span></a><a href="#configure"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure</span></a><a href="#disable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable</span></a><a href="#displayitemssubpage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>display<wbr/>Items<wbr/>Sub<wbr/>Page</span></a><a href="#enable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable</span></a><a href="#getcomponents" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Components</span></a><a href="#getconfig" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config</span></a><a href="#getdomelement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Dom<wbr/>Element</span></a><a href="#hasdomelement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Dom<wbr/>Element</span></a><a href="#hide" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hide</span></a><a href="#initialize" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initialize</span></a><a href="#isactive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Active</span></a><a href="#isdisabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Disabled</span></a><a href="#isenabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Enabled</span></a><a href="#ishidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Hidden</span></a><a href="#ishovered" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Hovered</span></a><a href="#isshown" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Shown</span></a><a href="#prependcomponent" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepend<wbr/>Component</span></a><a href="#release" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>release</span></a><a href="#removecomponent" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Component</span></a><a href="#removecomponents" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Components</span></a><a href="#setariaattr" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Aria<wbr/>Attr</span></a><a href="#setarialabel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Aria<wbr/>Label</span></a><a href="#show" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show</span></a><a href="#togglehidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Hidden</span></a><a href="#updatecomponents" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Components</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">bitmovin-player-ui</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
101
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from InteractiveSettingsPanelItem.updateComponents</p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/4eec683f50bbfd899d5a06a236ae2255da999144/src/ts/components/Container.ts#L123">src/ts/components/Container.ts:123</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#onactivechanged" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Active<wbr/>Changed</span></a><a href="#onclick" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Click</span></a><a href="#ondisabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Disabled</span></a><a href="#onenabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Enabled</span></a><a href="#onfocusedchanged" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Focused<wbr/>Changed</span></a><a href="#onhide" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Hide</span></a><a href="#onhoverchanged" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Hover<wbr/>Changed</span></a><a href="#onshow" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>Show</span></a><a href="#onviewmodechanged" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>on<wbr/>View<wbr/>Mode<wbr/>Changed</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addcomponent" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Component</span></a><a href="#configure"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure</span></a><a href="#disable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable</span></a><a href="#displayitemssubpage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>display<wbr/>Items<wbr/>Sub<wbr/>Page</span></a><a href="#enable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable</span></a><a href="#getcomponents" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Components</span></a><a href="#getconfig" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config</span></a><a href="#getdomelement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Dom<wbr/>Element</span></a><a href="#hasdomelement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Dom<wbr/>Element</span></a><a href="#hide" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hide</span></a><a href="#initialize" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initialize</span></a><a href="#isactive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Active</span></a><a href="#isdisabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Disabled</span></a><a href="#isenabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Enabled</span></a><a href="#ishidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Hidden</span></a><a href="#ishovered" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Hovered</span></a><a href="#isshown" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Shown</span></a><a href="#prependcomponent" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepend<wbr/>Component</span></a><a href="#release" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>release</span></a><a href="#removecomponent" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Component</span></a><a href="#removecomponents" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Components</span></a><a href="#setariaattr" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Aria<wbr/>Attr</span></a><a href="#setarialabel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Aria<wbr/>Label</span></a><a href="#show" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show</span></a><a href="#togglehidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Hidden</span></a><a href="#updatecomponents" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Components</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">bitmovin-player-ui</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|