import ConstrainedDateTime from './gui/data-items/ConstrainedDateTime.jsx'

public class | source

ConstrainedDateTime

Extends:

gui/data-items/SimpleDateTime.js~SimpleDateTime → ConstrainedDateTime

The purpose of ConstrainedDateTime is to store a date and time with constraints on the value. It will write to your tool's XML configuration the text of the date value set on it. It uses moment.js (https://momentjs.com/) for parsing and formatting date data. The display format and persistence format can be controlled through properties using moment.js formatting strings (https://momentjs.com/docs/#/displaying/format/). You can change the format of the string it persists in your tools XML configuration independent of the format of the string used for display. The default value is the current date and time in format of "YYYY\MM\DD hh:mm:ss".

Constructor Summary

Public Constructor
public	constructor(dataName: string, dataItemProps: object) Constructor

Public Constructors

public constructor(dataName: string, dataItemProps: object) source

Constructor

Params:

Name	Type	Attribute	Description
dataName	string		The name of the data item.
dataItemProps	object	optional	An object of properties such as hidden, disabled, suppressed etc.
dataItemProps.dateFormat	string	optional default: 'YYYY-MM-DD'	The "dateFormat" property is used for displaying the date. This string is used by moment.js for formatting, so is in its formatting syntax. You can find a reference for that here: https://momentjs.com/docs/#/parsing/string-format/
dataItemProps.dateTimeDelimiter	string	optional default: ' '	The "dateTimeDelimiter" property is used as the delimiter between the date and time formatting strings for display.
dataItemProps.timeFormat	string	optional default: 'HH:mm:ss'	The "timeFormat" property is used for displaying the time. This string is used by moment.js for formatting, so is in its formatting syntax. You can find a reference for that here: https://momentjs.com/docs/#/parsing/string-format/
dataItemProps.persistenceFormat	string	optional default: 'YYYY-MM-DD HH:mm:ss'	The "persistenceFormat" property is used for persisting the date in the tools XML configuration. This string is used by moment.js for formatting, so is in its formatting syntax. You can find a reference for that here: https://momentjs.com/docs/#/parsing/string-format/
dataItemProps.min	string	optional default: undefined	The min property specifies the minimum date time allowed. The format must match the dateFormat and timeFormat, with dateTimeDelimiter inbetween.
dataItemProps.max	string	optional default: undefined	The max property specifies the maximum date time allowed. The format must match the dateFormat and timeFormat, with dateTimeDelimiter inbetween.