Class: TimeSeriesObject

• new TimeSeriesObject(options)

• new TimeSeriesObject(options?)

TimeSeriesObjectBase.constructor

▸ dispose(): void

Dispose.

void

TimeSeriesObjectBase.dispose

▸ getAxis(): Axis

get axis

Axis

TimeSeriesObjectBase.getAxis

▸ getAxisOptions(): AxisOptionsOut

Get axis options

AxisOptionsOut

JSON which defines curve axis

TimeSeriesObjectBase.getAxisOptions

▸ getClassName(): string

string

TimeSeriesObjectBase.getClassName

▸ getCurveLimitsGroupOptions(): CurveLimitsOptionsOut

Get Curve Limits group option

CurveLimitsOptionsOut

▸ getCurveOptions(): CurveOptionsOut

Get curve options

CurveOptionsOut

▸ getData(): DataTable | DataTableView

Get curve's data

DataTable | DataTableView

▸ getId(): string

Get object's ID

string

TimeSeriesObjectBase.getId

▸ getLegendOptions(): LegendOptionsOut

Get legend options

LegendOptionsOut

JSON which defines legend options

▸ getName(): string

Gets time series object name

string

TimeSeriesObjectBase.getName

▸ getProperties(): OptionsOut

Returns all properties

OptionsOut

properties object

TimeSeriesObjectBase.getProperties

▸ getSymbolOptions(): SymbolOptionsOut

Get symbol options

SymbolOptionsOut

▸ getTooltipOptions(): TooltipOptions

Get tooltip options

TooltipOptions

JSON which defines tooltip options

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

TimeSeriesObjectBase.hasEventListener

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

TimeSeriesObjectBase.isDisposed

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

TimeSeriesObjectBase.isSilent

▸ notify<E>(type, source, args?): TimeSeriesObject

Notify listeners

TimeSeriesObject

this

TimeSeriesObjectBase.notify

▸ off<E>(type?, callback?): TimeSeriesObject

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

TimeSeriesObject

this

TimeSeriesObjectBase.off

▸ on<E>(type, callback): TimeSeriesObject

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

TimeSeriesObject

this

TimeSeriesObjectBase.on

▸ setAxisOptions(options?): TimeSeriesObject

Sets axis options. Refer to example below to make a curve's axis invisible. This can be useful to save space while displaying several curves that use the same vertical unit.
User would have to determine which curves share the same units and limits and hide the redundant axis.

TimeSeriesObject

TimeSeriesObjectBase.setAxisOptions

▸ setCurveLimitsGroupOptions(options?): TimeSeriesObject

Set curve limits group options

TimeSeriesObject

▸ setCurveOptions(options?): TimeSeriesObject

Set curve options

Example

// If you have several curves, which share the same unit and min&max,
// you can set the min and max of each curve dynamically and independently of each other without having to recreate the widget.
// You will have to iterate through the curves which you want to update and set their min and max value as follows:
widget.getTimeSeriesObjectById(curveid).setCurveOptions(
{ 'autoscale': false, 'min': newMinValue, 'max': newMaxValue}
);

TimeSeriesObject

▸ setData(options): TimeSeriesObject

Sets the data object for the line

Throws

if parameters indices and values are not specified properly

TimeSeriesObject

this

▸ setLegendOptions(options?): TimeSeriesObject

Set legend item options

TimeSeriesObject

this

▸ Protected setName(name): void

Set time series object name

void

TimeSeriesObjectBase.setName

▸ setProperties(props?): TimeSeriesObject

Sets all properties

TimeSeriesObject

this

TimeSeriesObjectBase.setProperties

▸ setSilent(bool): TimeSeriesObject

Set silent mode

TimeSeriesObject

this

TimeSeriesObjectBase.setSilent

▸ setSymbolOptions(options?): TimeSeriesObject

Set symbol options

TimeSeriesObject

▸ setTooltipOptions(options?): TimeSeriesObject

Set tooltip options

TimeSeriesObject

this

▸ updateLayout(): void

Update layout if it is necessary if object is changed

void

TimeSeriesObjectBase.updateLayout

▸ Static getClassName(): string

string

TimeSeriesObjectBase.getClassName