# Interface: TimeRangeComponent
# Hierarchy
-
↳
TimeRangeComponent
# Table of contents
# Properties
# Methods
- disable
- enable
- getTimeRange
- getValue
- hide
- isVisible
- onClick
- setTimeRange
- setValue
- show
- toggle
- updateDom
# Properties
# el
• el: HTMLElement
Compiled Component's element from passed domString parameter.
# Inherited from
# wrapperEl
• wrapperEl: HTMLElement
Component's wrapper element.
# Inherited from
# Methods
# disable
▸ disable(): void
# Returns
void
# Inherited from
# enable
▸ enable(): void
# Returns
void
# Inherited from
# getTimeRange
▸ getTimeRange(): TimeRange
Returns a selected range of time shown on UI in seconds.
# Returns
# getValue
▸ getValue(dataAttr): string
Gets the value of innerHtml from element which matched by @param dataAttr.
# Parameters
| Name | Type | Description |
|---|---|---|
dataAttr | string | the name of the data attribute to match the component's element. <div data-test-value>Test value</div> component.getValue("test-value") // returns "Test value" |
# Returns
string
# Inherited from
# hide
▸ hide(): void
Hides time range controls from player's timeline.
# Returns
void
# Overrides
# isVisible
▸ isVisible(): boolean
Returns true if component is visible, false otherwise.
# Returns
boolean
# Inherited from
# onClick
▸ onClick(event?): void
On component click handler function
# Parameters
| Name | Type |
|---|---|
event? | Event |
# Returns
void
# Inherited from
# setTimeRange
▸ setTimeRange(range): void
Selects the given time range on UI in TimeRangeComponent.
Note: the duration of the shown "base range" is constrained up to 2 minutes.
# Parameters
| Name | Type |
|---|---|
range | TimeRange |
# Returns
void
# setValue
▸ setValue(dataAttr, value): void
Replaces the value of innerHtml from element which matched by @param dataAttr.
# Parameters
| Name | Type | Description |
|---|---|---|
dataAttr | string | the name of the data attribute to match the component's element. <div data-test-value>Test value</div> component.setValue("test-value", "Replaced") // Will replace the text in div to "Replaced" text. |
value | any | - |
# Returns
void
# Inherited from
# show
▸ show(): void
Shows time range controls on player's timeline.
# Returns
void
# Overrides
# toggle
▸ toggle(): void
Toggles time range controls.
# Returns
void
# updateDom
▸ updateDom(domString): void
Updates components DOM with provided domString parameter.
# Parameters
| Name | Type |
|---|---|
domString | string |
# Returns
void