Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ShadowAccumulationViewModel

Hierarchy

Index

Properties

date

date: Date

The calendar date used to calculate the shadow accumulation.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

discreteOptions

The configuration used when the widget's visualizationType is set to "discrete".

Read more...

durationOptions

The configuration used when the widget's visualizationType is set to "duration".

Read more...

endTimeOfDay

endTimeOfDay: number

Time (in milliseconds from midnight of the date) when the shadow accumulation computation should stop.

Read more...

initialized

initialized: boolean

startTimeOfDay

startTimeOfDay: number

Time (in milliseconds from midnight of the date) when the shadow accumulation computation should start.

Read more...

Readonly state

state: "disabled" | "ready"

The current state of the view model that can be used for rendering the UI of the widget.

Read more...

thresholdOptions

The configuration used when the widget's visualizationType is set to "threshold".

Read more...

utcOffset

utcOffset: number

The difference in hours between UTC time and the times displayed in the widget.

Read more...

view

view: SceneView

A reference to the View.

Read more...

visualizationType

visualizationType: "threshold" | "duration" | "discrete"

Type of visualization to use when showing the shadows.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ShadowAccumulationViewModel

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getDuration

  • Returns the time (in milliseconds) spent in shadow for a certain point on the screen.

    Read more...

    Parameters

    Returns number

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

start

  • start(): void
  • Starts the widget.

    Read more...

    Returns void

stop

  • stop(): void
  • Stops the widget.

    Read more...

    Returns void

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc