stringAdds timestamp to a string date.
\nDateValueGet a DateValue object for a period described by a period, compare value, and start/end\ndates, for custom dates.
\nObjectMemoized internal logic of getDateParamsFromQuery().
\nDateParamsAdd default date-related parameters to a query object
\nObjectMemoized internal logic of getCurrentDates().
\nObjectGet Date Value Objects for a primary and secondary date range
\nnumberCalculates the date difference between two dates. Used in calculating a matching date for previous period.
\nObjectGet the previous date for either the previous period of year.
\nObject | nullConvert a string to Moment object
\nstringGiven two dates, derive a string representation
\nstringGets the current time in the store time zone if set.
\nDateValueGet a DateValue object for a period prior to the current period.
\nDateValueGet a DateValue object for a current period. The period begins on the first day of the period,\nand ends on the current day.
\nArrayReturns the allowed selectable intervals for a specific query.
\nstringReturns the current interval to use.
\nstringReturns the current chart type to use.
\nstringReturns date formats for the current interval.
\nstringReturns d3 date formats for the current interval.\nSee https://github.com/d3/d3-time-format for chart formats.
\nstringReturns php date formats for the current interval.\nSee see https://www.php.net/manual/en/datetime.format.php.
\nGutenberg's moment instance is loaded with i18n values, which are\nPHP date formats, ie 'LLL: "F j, Y g:i a"'. Override those with translations\nof moment style js formats.
\nObjectValidate text input supplied for a date range.
\nObjectDateValue Object
\nObjectDateParams Object
\nObjectstring\nAdds timestamp to a string date.\n\n**Kind**: global constant\n**Returns**: string - - String date with timestamp attached.\n\n| Param | Type | Description |\n| --- | --- | --- |\n| date | moment.Moment | Date as a moment object. |\n| timeOfDay | string | Either `start`, `now` or `end` of the day. |\n\n\n\n### getDateValue ⇒ [DateValue](#DateValue)\nGet a DateValue object for a period described by a period, compare value, and start/end\ndates, for custom dates.\n\n**Kind**: global constant\n**Returns**: [DateValue](#DateValue) - - DateValue data about the selected period\n\n| Param | Type | Description |\n| --- | --- | --- |\n| period | string | the chosen period |\n| compare | string | `previous_period` or `previous_year` |\n| [after] | Object | after date if custom period |\n| [before] | Object | before date if custom period |\n\n\n\n### getDateParamsFromQueryMemoized ⇒ Object\nMemoized internal logic of getDateParamsFromQuery().\n\n**Kind**: global constant\n**Returns**: Object - - date parameters derived from query parameters with added defaults\n\n| Param | Type | Description |\n| --- | --- | --- |\n| period | string | period value, ie `last_week` |\n| compare | string | compare value, ie `previous_year` |\n| after | string | date in iso date format, ie `2018-07-03` |\n| before | string | date in iso date format, ie `2018-07-03` |\n| defaultDateRange | string | the store's default date range |\n\n\n\n### getDateParamsFromQuery ⇒ [DateParams](#DateParams)\nAdd default date-related parameters to a query object\n\n**Kind**: global constant\n**Returns**: [DateParams](#DateParams) - - date parameters derived from query parameters with added defaults\n\n| Param | Type | Description |\n| --- | --- | --- |\n| query | Object | query object |\n| query.period | string | period value, ie `last_week` |\n| query.compare | string | compare value, ie `previous_year` |\n| query.after | string | date in iso date format, ie `2018-07-03` |\n| query.before | string | date in iso date format, ie `2018-07-03` |\n| defaultDateRange | string | the store's default date range |\n\n\n\n### getCurrentDatesMemoized ⇒ Object\nMemoized internal logic of getCurrentDates().\n\n**Kind**: global constant\n**Returns**: Object - - Primary and secondary DateValue objects\n\n| Param | Type | Description |\n| --- | --- | --- |\n| period | string | period value, ie `last_week` |\n| compare | string | compare value, ie `previous_year` |\n| primaryStart | Object | primary query start DateTime, in Moment instance. |\n| primaryEnd | Object | primary query start DateTime, in Moment instance. |\n| secondaryStart | Object | primary query start DateTime, in Moment instance. |\n| secondaryEnd | Object | primary query start DateTime, in Moment instance. |\n\n\n\n### getCurrentDates ⇒ Object\nGet Date Value Objects for a primary and secondary date range\n\n**Kind**: global constant\n**Returns**: Object - - Primary and secondary DateValue objects\n\n| Param | Type | Description |\n| --- | --- | --- |\n| query | Object | query object |\n| query.period | string | period value, ie `last_week` |\n| query.compare | string | compare value, ie `previous_year` |\n| query.after | string | date in iso date format, ie `2018-07-03` |\n| query.before | string | date in iso date format, ie `2018-07-03` |\n| defaultDateRange | string | the store's default date range |\n\n\n\n### getDateDifferenceInDays ⇒ number\nCalculates the date difference between two dates. Used in calculating a matching date for previous period.\n\n**Kind**: global constant\n**Returns**: number - - Difference in days.\n\n| Param | Type | Description |\n| --- | --- | --- |\n| date | string | Date to compare |\n| date2 | string | Secondary date to compare |\n\n\n\n### getPreviousDate ⇒ Object\nGet the previous date for either the previous period of year.\n\n**Kind**: global constant\n**Returns**: Object - - Calculated date\n\n| Param | Type | Description |\n| --- | --- | --- |\n| date | string | Base date |\n| date1 | string | primary start |\n| date2 | string | secondary start |\n| compare | string | `previous_period` or `previous_year` |\n| interval | string | interval |\n\n\n\n### toMoment(format, str) ⇒ Object \\| null\nConvert a string to Moment object\n\n**Kind**: global function\n**Returns**: Object \\| null - - Moment object representing given string\n\n| Param | Type | Description |\n| --- | --- | --- |\n| format | string | localized date string format |\n| str | string | date string |\n\n\n\n### getRangeLabel(after, before) ⇒ string\nGiven two dates, derive a string representation\n\n**Kind**: global function\n**Returns**: string - - text value for the supplied date range\n\n| Param | Type | Description |\n| --- | --- | --- |\n| after | Object | start date |\n| before | Object | end date |\n\n\n\n### getStoreTimeZoneMoment() ⇒ string\nGets the current time in the store time zone if set.\n\n**Kind**: global function\n**Returns**: string - - Datetime string.\n\n\n### getLastPeriod(period, compare) ⇒ [DateValue](#DateValue)\nGet a DateValue object for a period prior to the current period.\n\n**Kind**: global function\n**Returns**: [DateValue](#DateValue) - - DateValue data about the selected period\n\n| Param | Type | Description |\n| --- | --- | --- |\n| period | string | the chosen period |\n| compare | string | `previous_period` or `previous_year` |\n\n\n\n### getCurrentPeriod(period, compare) ⇒ [DateValue](#DateValue)\nGet a DateValue object for a current period. The period begins on the first day of the period,\nand ends on the current day.\n\n**Kind**: global function\n**Returns**: [DateValue](#DateValue) - - DateValue data about the selected period\n\n| Param | Type | Description |\n| --- | --- | --- |\n| period | string | the chosen period |\n| compare | string | `previous_period` or `previous_year` |\n\n\n\n### getAllowedIntervalsForQuery(query, defaultDateRange) ⇒ Array\nReturns the allowed selectable intervals for a specific query.\n\n**Kind**: global function\n**Returns**: Array - Array containing allowed intervals.\n\n| Param | Type | Description |\n| --- | --- | --- |\n| query | Object | Current query |\n| defaultDateRange | string | the store's default date range |\n\n\n\n### getIntervalForQuery(query, defaultDateRange) ⇒ string\nReturns the current interval to use.\n\n**Kind**: global function\n**Returns**: string - Current interval.\n\n| Param | Type | Description |\n| --- | --- | --- |\n| query | Object | Current query |\n| defaultDateRange | string | the store's default date range |\n\n\n\n### getChartTypeForQuery(query) ⇒ string\nReturns the current chart type to use.\n\n**Kind**: global function\n**Returns**: string - Current chart type.\n\n| Param | Type | Description |\n| --- | --- | --- |\n| query | Object | Current query |\n| query.chartType | string | |\n\n\n\n### getDateFormatsForInterval(interval, [ticks], [option]) ⇒ string\nReturns date formats for the current interval.\n\n**Kind**: global function\n**Returns**: string - Current interval.\n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval | string | Interval to get date formats for. |\n| [ticks] | number | Number of ticks the axis will have. |\n| [option] | Object | Options |\n| [option.type] | string | Date format type, d3 or php, defaults to d3. |\n\n\n\n### getDateFormatsForIntervalD3(interval, [ticks]) ⇒ string\nReturns d3 date formats for the current interval.\nSee https://github.com/d3/d3-time-format for chart formats.\n\n**Kind**: global function\n**Returns**: string - Current interval.\n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval | string | Interval to get date formats for. |\n| [ticks] | number | Number of ticks the axis will have. |\n\n\n\n### getDateFormatsForIntervalPhp(interval, [ticks]) ⇒ string\nReturns php date formats for the current interval.\nSee see https://www.php.net/manual/en/datetime.format.php.\n\n**Kind**: global function\n**Returns**: string - Current interval.\n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval | string | Interval to get date formats for. |\n| [ticks] | number | Number of ticks the axis will have. |\n\n\n\n### loadLocaleData(config)\nGutenberg's moment instance is loaded with i18n values, which are\nPHP date formats, ie 'LLL: \"F j, Y g:i a\"'. Override those with translations\nof moment style js formats.\n\n**Kind**: global function\n\n| Param | Type | Description |\n| --- | --- | --- |\n| config | Object | Locale config object, from store settings. |\n| config.userLocale | string | |\n| config.weekdaysShort | Array | |\n\n\n\n### validateDateInputForRange(type, value, [before], [after], format) ⇒ Object\nValidate text input supplied for a date range.\n\n**Kind**: global function\n**Returns**: Object - validatedDate - validated date object\n\n| Param | Type | Description |\n| --- | --- | --- |\n| type | string | Designate beginning or end of range, eg `before` or `after`. |\n| value | string | User input value |\n| [before] | Object \\| null | If already designated, the before date parameter |\n| [after] | Object \\| null | If already designated, the after date parameter |\n| format | string | The expected date format in a user's locale |\n\n\n\n### DateValue : Object\nDateValue Object\n\n**Kind**: global typedef\n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| label | string | The translated value of the period. |\n| range | string | The human readable value of a date range. |\n| after | moment.Moment | Start of the date range. |\n| before | moment.Moment | End of the date range. |\n\n\n\n### DateParams : Object\nDateParams Object\n\n**Kind**: global typedef\n\n| Param | Type | Description |\n| --- | --- | --- |\n| after | moment.Moment \\| null | If the period supplied is \"custom\", this is the after date |\n| before | moment.Moment \\| null | If the period supplied is \"custom\", this is the before date |\n\n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| period | string | period value, ie `last_week` |\n| compare | string | compare valuer, ie previous_year |\n\n\n\n### validatedDate : Object\n**Kind**: global typedef\n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| date | Object \\| null | A resulting Moment date object or null, if invalid |\n| error | string | An optional error message if date is invalid |\n","readmeFilename":"README.md"}