@jdultra/ultra-globe

---

@jdultra/ultra-globe / TimelineLayer

Class: TimelineLayer

Defined in: layers/TimelineLayer.d.ts:9

Shared interactive timeline UI for global time navigation and time-addressable assets.

The timeline operates in absolute Unix milliseconds. Attached assets are projected into the same global time window when their adapters can resolve absolute timestamps.

Extends

• Layer

Constructors

Constructor

new TimelineLayer(properties?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:23

Parameters

properties?

Object

Returns

TimelineLayer

Overrides

Layer.constructor

Properties

attribution

attribution: string | null

Defined in: layers/Layer.d.ts:29

Inherited from

Layer.attribution

---

bounds

bounds: any

Defined in: layers/Layer.d.ts:26

Inherited from

Layer.bounds

---

id

id: string | number

Defined in: layers/Layer.d.ts:24

Inherited from

Layer.id

---

isLayer

isLayer: boolean

Defined in: layers/Layer.d.ts:22

Inherited from

Layer.isLayer

---

isSelectable

isSelectable: boolean

Defined in: layers/Layer.d.ts:23

Inherited from

Layer.isSelectable

---

isTimelineLayer

isTimelineLayer: boolean

Defined in: layers/TimelineLayer.d.ts:35

---

listeners

listeners: Object

Defined in: layers/Layer.d.ts:28

Inherited from

Layer.listeners

---

map

map: any

Defined in: layers/Layer.d.ts:92

Inherited from

Layer.map

---

name

name: string

Defined in: layers/Layer.d.ts:25

Inherited from

Layer.name

---

paused

paused: boolean | undefined

Defined in: layers/Layer.d.ts:82

Inherited from

Layer.paused

---

visible

visible: boolean

Defined in: layers/Layer.d.ts:27

Inherited from

Layer.visible

Methods

addListener()

addListener(key, listener): void

Defined in: layers/Layer.d.ts:74

Adds a listener for layer events

Parameters

key

any

can be anything but should be unique

listener

Function

a function : (layer, eventType)=>{}

Returns

void

Inherited from

Layer.addListener

---

attachAsset()

attachAsset(asset, options?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:87

Parameters

asset

any

options?

Object

Returns

TimelineLayer

---

attachAssets()

attachAssets(assets, options?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:95

Parameters

assets

any[]

options?

Object

Returns

TimelineLayer

---

attachLayer()

attachLayer(asset, options?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:103

Parameters

asset

any

options?

Object

Returns

TimelineLayer

---

attachLayers()

attachLayers(assets, options?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:111

Parameters

assets

any[]

options?

Object

Returns

TimelineLayer

---

detachAsset()

detachAsset(assetOrId): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:118

Parameters

assetOrId

any

Returns

TimelineLayer

---

detachLayer()

detachLayer(assetOrId): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:123

Parameters

assetOrId

any

Returns

TimelineLayer

---

dispose()

dispose(): void

Defined in: layers/Layer.d.ts:87

disposes of any resources used by this layer

Returns

void

Inherited from

Layer.dispose

---

focusAsset()

focusAsset(assetOrId, options?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:238

Moves selection focus to an attached asset and, when possible, moves the map camera.

Parameters

assetOrId

any

options?

Object

Returns

TimelineLayer

---

getAssets()

getAssets(): any[]

Defined in: layers/TimelineLayer.d.ts:127

Returns

any[]

---

getBounds()

getBounds(): Box2

Defined in: layers/Layer.d.ts:62

Returns

Box2

bounds in longitude latitude (degrees)

Inherited from

Layer.getBounds

---

getCenter()

getCenter(sfct): Vector3

Defined in: layers/Layer.d.ts:37

Moves a given point to this layer's center in degree longitude/latitude

Parameters

sfct

Vector3

a point to move

Returns

Vector3

the input point

Inherited from

Layer.getCenter

---

getCurrentTime()

getCurrentTime(): number

Defined in: layers/TimelineLayer.d.ts:131

Returns

number

---

getDuration()

getDuration(): number

Defined in: layers/TimelineLayer.d.ts:141

Returns the total absolute asset span in milliseconds.

Returns

number

---

getID()

getID(): string | number

Defined in: layers/Layer.d.ts:42

Returns

string | number

layer id

Inherited from

Layer.getID

---

getName()

getName(): string

Defined in: layers/Layer.d.ts:47

Returns

string

layer name

Inherited from

Layer.getName

---

getPlaybackRate()

getPlaybackRate(): number

Defined in: layers/TimelineLayer.d.ts:163

Returns

number

---

getReplaySpeed()

getReplaySpeed(): number

Defined in: layers/TimelineLayer.d.ts:159

Returns

number

---

getSelectedAsset()

getSelectedAsset(): any

Defined in: layers/TimelineLayer.d.ts:177

Returns

any

---

getTimelineTime()

getTimelineTime(): number

Defined in: layers/TimelineLayer.d.ts:135

Returns

number

---

getViewState()

getViewState(): Object

Defined in: layers/TimelineLayer.d.ts:145

Returns

Object

---

isPlaying()

isPlaying(): boolean

Defined in: layers/TimelineLayer.d.ts:155

Returns

boolean

---

pause()

pause(): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:220

Returns

TimelineLayer

---

play()

play(): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:216

Returns

TimelineLayer

---

raycast()

raycast(raycaster): any[]

Defined in: layers/Layer.d.ts:80

raycasts through objects from this layer if the layer is selectable and if the objects are raycastable

Parameters

raycaster

Object

a three.js Raycaster

Returns

any[]

an array of selected objects

Inherited from

Layer.raycast

---

removeListener()

removeListener(key): void

Defined in: layers/Layer.d.ts:68

Removes the listener associated to the given key

Parameters

key

any

can be anything but should be unique

Returns

void

Inherited from

Layer.removeListener

---

selectAsset()

selectAsset(assetOrId): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:182

Parameters

assetOrId

any

Returns

TimelineLayer

---

setCurrentTime()

setCurrentTime(time, options?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:202

Backward-compatible alias for setting the global timeline time.

Parameters

time

string | number | Date

options?

Object

Returns

TimelineLayer

---

setName()

setName(name): void

Defined in: layers/Layer.d.ts:52

change the layer name

Parameters

name

string

Returns

void

Inherited from

Layer.setName

---

setPlaybackRate()

setPlaybackRate(playbackRate): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:173

Parameters

playbackRate

number

Returns

TimelineLayer

---

setReplaySpeed()

setReplaySpeed(replaySpeed): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:168

Parameters

replaySpeed

number

Returns

TimelineLayer

---

setTimelineTime()

setTimelineTime(time, options?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:190

Sets the global timeline time.

Parameters

time

string | number | Date

options?

Object

Returns

TimelineLayer

---

setViewWindow()

setViewWindow(startTime, durationMilliseconds): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:212

Parameters

startTime

string | number | Date

durationMilliseconds

number

Returns

TimelineLayer

---

setVisible()

setVisible(visible): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:81

Parameters

visible

boolean

Returns

TimelineLayer

Overrides

Layer.setVisible

---

togglePlayback()

togglePlayback(): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:224

Returns

TimelineLayer

---

zoomBy()

zoomBy(factor, anchorTime?): TimelineLayer

Defined in: layers/TimelineLayer.d.ts:230

Parameters

factor

number

anchorTime?

number

Returns

TimelineLayer