dojox/date/relative.js

• Provides:

  • dojox.date.relative

• Requires:

  • dojo.date in common
  • dojo.date.locale in common

• dojox.date.relative.__FormatOptions

  • type

    Function

• dojox.date.relative.__FormatOptions.locale

  • type

    String

  • summary

    override the locale used to determine formatting rules

• dojox.date.relative.__FormatOptions.relativeDate

  • type

    Date

  • summary

    Date to calculate relation to (defaults to new Date())

• dojox.date.relative.__FormatOptions.weekCheck

  • type

    boolean

  • summary

    Whether or not to display the day of week (defaults true)

• dojo.delegate

  • alias - dojo.delegate

• dojo.date.locale

  • alias - dojo.date.locale

• dojo.date.locale._getGregorianBundle

  • alias - dojo.date.locale._getGregorianBundle

• dojo.date.locale.format

  • alias - dojo.date.locale.format

• dojox.date.relative.format

  • parameters:
    • dateObject: (typeof Date)

      the date and time to be formatted.

    • options: (typeof dojox.date.relative.__FormatOptions)
  • summary

    Format a Date object as a String, using locale-specific settings,
    relative to the current date or some other date.

  • description

    Create a string from a Date object using the most significant information
    and a known localized pattern.  This method formats both the date and
    time from dateObject.  Formatting patterns are chosen appropriate to
    the locale.
    
    If the day portion of the date falls within the current date (or the
    relativeDate option, if present), then the time will be all that
    is displayed
    
    If the day portion of the date falls within the past week (or the
    week preceeding relativeDate, if present), then the display will show
    day of week and time.  This functionality can be turned off by setting
    weekCheck to false.
    
    If the year portion of the date falls within the current year (or the
    year portion of relativeDate, if present), then the display will show
    month and day.
    
    Otherwise, this function is equivalent to calling dojo.date.format with
    formatLength of "medium"

  • type

    Function

• dojox.date.relative

  • type

    Object

• dojox.date

  • type

    Object

• dojox

  • type

    Object