Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents settings for a time slider profile displayed in the time slider when there are time aware map services in the map.

Hierarchy

Index

Constructors

constructor

Events

onInitializationFailed

onInitializationFailed: function

Occurs when initialization of this object fails.

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

onInitialized

onInitialized: function

Occurs when initialization succeeds with a response from the REST endpoint. Depending on the API, this response may actually be an error message served as a correct HTTP response.

Type declaration

    • (sender: any): void
    • Parameters

      • sender: any

      Returns void

Properties

Private _initializing

_initializing: boolean

description

description: string

The description for the TimeSliderProfile.

displayFormat

displayFormat: string

The display format for this TimeSliderProfile

displayName

displayName: string

The display name for the TimeSliderProfile.

extensions

extensions: Extension[]

The collection of Extension objects associated with the time slider profile. Extensions can be defined by the administrator on the server.

id

id: string

The ID of the TimeSliderProfile

initialTimeExtent

initialTimeExtent: TimeExtent

The initial time extent this slider will be set to

initializationFailure

initializationFailure: Error

The exception that occurred if the object could not be initialized.

isInitialized

isInitialized: boolean

Whether or not the object was successfully initialized.

mode

The mode of operation for this TimeSliderProfile

properties

properties: any

The properties of the TimeSliderProfile, as defined by the administrator on the server.

site

The {@link geocortex.essentials.Site} that this resource belongs to.

snapToTimeIntervals

snapToTimeIntervals: boolean

A boolean which indicates whether this time slider will snap to the defined time intervals or not

timeExtent

timeExtent: TimeExtent

The complete time extent this slider will display

timeInterval

timeInterval: number

The time interval this time slider profile will be divided into

timeIntervalUnit

timeIntervalUnit: TimeUnits

The unit of time that describes the time interval

url

url: string

The URL that this resource was initialized from.

Methods

_configureObject

  • _configureObject(results: RestTimeSlider, deepInitialize?: boolean): void

Private _initializationFailedHandler

  • _initializationFailedHandler(err: Error): void

Private _initializedHandler

  • _initializedHandler(sender: any): void

Private _restErrorHandler

  • _restErrorHandler(error: Error): void

Private _restLoadHandler

  • _restLoadHandler(deepInitialize: boolean, result: any): void

doWhenInitialized

  • doWhenInitialized(callback: function): void
  • doWhenInitialized(scope: any, callback: function): void
  • Parameters

    Returns void

  • Performs a callback function when this instance has been initialized. If this instance is already initialized when this function is called, the callback function will execute immediately.

    Parameters

    • scope: any

      The scope to using when executing the callback - i.e. the value of the 'this' variable in the callback function. This parameter may be ommitted in which cased the first parameter will be used as the callback function.

    • callback: function

      The callback function to execute when this instance has been initialized.

    Returns void

initialize

  • initialize(obj?: any): void
  • Initializes the {@link geocortex.essentials.AsyncInitializable}. This is an asynchronous method, you may subscribe to the onInitialized and onInitializationFailed events for completion information.

    Parameters

    • Optional obj: any

    Returns void