Rogue Wave JViews Charts JavaScript Reference: Class IlvDataInterval

Class IlvDataInterval

IlvDataInterval

Category:: Rich Web Charts component

JavaScript File:: IlvDataInterval.js

Description:: A class to handle range of data.

Deprecated:
RWC has been deprecated since JViews 8.7. Alternative Web technologies are provided with your JViews product.

Since:: JViews 7.5

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvDataInterval(min, max)

Method Summary
Method Attributes	Method Name and Description
	addInterval(itv) Adds the given interval.
	addValue(val) Adds the given value to this interval.
	clamp(value) Clamps the specified value to this interval.
	clone() Returns a copy of this data interval.
	contains(itv) Returns whether the given interval is included within this interval.
	empty() Empties this interval.
	equals(obj) Returns whether this data interval is equal to the specified data interval.
	expand(delta) Expands the interval from the given value.
	getLength() Returns the length of this interval.
	getMax() Returns the maximum bound.
	getMiddle() Returns the middle value of this interval.
	getMin() Returns the minimum bound.
	intersection(itv) Computes the intersection of this interval with the given interval and modifies this data interval accordingly.
	intersects(itv) Returns whether the given interval intersects this interval.
	isAfter(val) Returns whether the given value is greater than or equal to the maximum bound.
	isBefore(val) Returns whether the given value is lower than or equal to the minimum bound.
	isEmpty() Returns whether this interval is empty.
	isInside(val) Returns whether the given value is included within this interval.
	isOutside(val) Returns whether the given value lies outside this interval.
	isStrictlyAfter(val) Returns whether the given value is strictly greater than the maximum bound.
	isStrictlyBefore(val) Returns whether the given value is strictly lower than the minimum bound.
	isStrictlyInside(val) Returns whether the given value is strictly included within this interval.
	isStrictlyOutside(val) Returns whether the given value lies strictly outside this interval.
	set(min, max) Sets the minimum and maximum bounds.
	setMax(val) Sets the maximum bound.
	setMin(val) Sets the minimum bound.
	toString() Returns a string representation of this data interval.
	translate(delta) Translates the interval from the given value.

Constructor Detail

IlvDataInterval

IlvDataInterval(min, max)

Parameters:: min - The minimum bound.; max - The maximum bound.

Method Detail

addInterval

addInterval(itv)

Adds the given interval. This method updates the bounds values depending if the minimum bound of the given interval is lower than the current minimum bound or if the maximum bound of the given interval is greater than the current maximum bound.

The method also distinguishes two specific cases:

The specified interval is empty. In this case, the current interval is not modified.
The current interval is empty. In this case, the current interval is set to be equal to the specified interval.

Parameters:: itv

Returns:: Whether the bounds of the current interval have changed.

addValue

addValue(val)

Adds the given value to this interval. This method updates the bounds values accordingly if the value is lower than the minimum bound or greater than the maximum bound.

Parameters:: val

Returns:: Whether the interval bounds have changed.

clamp

clamp(value)

Clamps the specified value to this interval. The returned value is computed according to the following rules:

The value is returned if the interval is empty or if it contains value.
The minimum value of the interval is returned if value is before the interval.
The maximum value of the interval is returned if value is after the interval.

Parameters:: value

clone

clone()

Returns a copy of this data interval.

contains

contains(itv)

Returns whether the given interval is included within this interval.

Parameters:: itv

empty

empty()

Empties this interval. By definition, an interval is empty if its maximum bound is lower than its minimum bound.

equals

equals(obj)

Returns whether this data interval is equal to the specified data interval. By definition, two data intervals are equal if both their minimum bounds and maximum bounds are equal.

Parameters:: obj

expand

expand(delta)

Expands the interval from the given value. The new bounds are min-delta, max+delta. This method has no effects on an empty interval.

Parameters:: delta

getLength

getLength()

Returns the length of this interval.

getMax

getMax()

Returns the maximum bound.

getMiddle

getMiddle()

Returns the middle value of this interval.

getMin

getMin()

Returns the minimum bound.

intersection

intersection(itv)

Computes the intersection of this interval with the given interval and modifies this data interval accordingly.

Parameters:: itv

intersects

intersects(itv)

Returns whether the given interval intersects this interval.

Parameters:: itv

isAfter

isAfter(val)

Returns whether the given value is greater than or equal to the maximum bound.

Parameters:: val

isBefore

isBefore(val)

Returns whether the given value is lower than or equal to the minimum bound.

Parameters:: val

isEmpty

isEmpty()

Returns whether this interval is empty.

See also:: #empty

isInside

isInside(val)

Returns whether the given value is included within this interval.

Parameters:: val

isOutside

isOutside(val)

Returns whether the given value lies outside this interval.

Parameters:: val

isStrictlyAfter

isStrictlyAfter(val)

Returns whether the given value is strictly greater than the maximum bound.

Parameters:: val

isStrictlyBefore

isStrictlyBefore(val)

Returns whether the given value is strictly lower than the minimum bound.

Parameters:: val

isStrictlyInside

isStrictlyInside(val)

Returns whether the given value is strictly included within this interval.

Parameters:: val

isStrictlyOutside

isStrictlyOutside(val)

Returns whether the given value lies strictly outside this interval.

Parameters:: val

set

set(min, max)

Sets the minimum and maximum bounds.

Parameters:: min; max

setMax

setMax(val)

Sets the maximum bound.

Parameters:: val

setMin

setMin(val)

Sets the minimum bound.

Parameters:: val

toString

toString()

Returns a string representation of this data interval.

translate

translate(delta)

Translates the interval from the given value. The new bounds are min+delta, max+delta.

Parameters:: delta