ig.scheduler.TimeRange

Represents a contiguous block of time.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_web.js
infragistics.dv_core.js
infragistics.dv_jquerydom.js
infragistics.dv_interactivity.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • ig.scheduler.TimeRange
    Constructor

    new $.ig.scheduler.TimeRange( );

    Creates a new instance.

  • ig.scheduler.TimeRange
    Constructor

    new $.ig.scheduler.TimeRange( start:ig.Number, end:ig.Number );

    Creates a new instance.

    • start
    • Type:ig.Number
    • The start time for the range.
    • end
    • Type:ig.Number
    • The exclusive end time for the range.

    Remarks

    The value of each parameter must be non-negative or an exception is thrown.

    The value of each parameter must be less than one day or an exception is thrown.

  • clone

    .clone( );

  • contains

    .contains( value:ig.Number, [isEndExclusive:boolean] );

    Returns true if the specified TimeSpan lies completely within this range.

    • value
    • Type:ig.Number
    • The TimeSpan to test.
    • isEndExclusive
    • Type:boolean
    • Optional
    • Determines whether to exclude the moment in time that coincides with the value of the TimeRange.end property. This parameter default to true.
  • end

    .end( );

    Defines the exclusive end of the range. A value exactly equal to the value of this property is outside the range; a value less than the value of this property and greater than or equal to the value of the TimeRange.start property is within range.

  • end

    .end( value:ig.Number );

    Defines the exclusive end of the range. A value exactly equal to the value of this property is outside the range; a value less than the value of this property and greater than or equal to the value of the TimeRange.start property is within range.

    • value
    • Type:ig.Number
  • equals

    .equals( obj:object );
    Return Type:
    boolean
    Return Type Description:
    True if the specified instance is equal to this instance otherwise, false.

    Returns a value indicating whether this instance is equal to a specified object.

    • obj
    • Type:object
    • An object to compare with this instance.
  • getHashCode

    .getHashCode( );
    Return Type:
    number
    Return Type Description:
    A hash code for this instance.

    Returns a hash code for this instance.

  • intersectsWith

    .intersectsWith( value:ig.scheduler.TimeRange, [isEndExclusive:boolean] );

    Returns true if the specified TimeRange intersects with this range.

    • value
    • Type:ig.scheduler.TimeRange
    • The TimeRange to test.
    • isEndExclusive
    • Type:boolean
    • Optional
    • Determines whether to exclude the moment in time that coincides with the value of the TimeRange.end property. This parameter default to true.
  • start

    .start( );

    Defines the beginning of the range.

  • start

    .start( value:ig.Number );

    Defines the beginning of the range.

    • value
    • Type:ig.Number
  • toString

    .toString( );

    Returns the string representation of this object.

  • validateEnd

    .validateEnd( value:ig.Number );

    When overridden in a derived class, provides a way to validate the value being assigned to the End property.

    • value
    • Type:ig.Number
  • validateStart

    .validateStart( value:ig.Number );

    When overridden in a derived class, provides a way to validate the value being assigned to the Start property.

    • value
    • Type:ig.Number

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.