Class DateTimeTickStrategy <TProps >

Methods

__@iterator

__@iterator(): IterableIterator<[keyof TProps, TProps[keyof TProps]]>

Returns IterableIterator<[keyof TProps, TProps[keyof TProps]]>

asImmutable

asImmutable(): this

Returns this

asMutable

asMutable(): this

Returns this

clear

clear(): this

Returns this

delete

delete(key: K): this

Type parameters
- K: keyof TProps
Parameters
- key: K
Returns this

deleteIn

deleteIn(keyPath: Iterable<any>): this

Parameters
- keyPath: Iterable<any>
Returns this

equals

equals(other: any): boolean

Parameters
- other: any
Returns boolean

get

get(key: K, notSetValue: any): TProps[K]
get(key: string, notSetValue: T): T

Type parameters
- K: keyof TProps
Parameters
- key: K
- Optional notSetValue: any
Returns TProps[K]
Type parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T

getDateOrigin

getDateOrigin(): Date | undefined

Returns Date | undefined

A JavaScript Date object or undefined.

getGreatTickStyle

getGreatTickStyle(): TickStyle

Returns TickStyle

Great tick style.

getIn

getIn(keyPath: Iterable<any>): any

Parameters
- keyPath: Iterable<any>
Returns any

getLocale

getLocale(): string | undefined

Returns string | undefined

JavaScript Date locale string, that specifies a geographical, political or cultural region.

getMajorTickStyle

getMajorTickStyle(): TickStyle

Returns TickStyle

Major tick style.

getMinorTickStyle

getMinorTickStyle(): TickStyle

Returns TickStyle

Minor tick style.

has

has(key: string): boolean

Parameters
- key: string
Returns boolean

hasIn

hasIn(keyPath: Iterable<any>): boolean

Parameters
- keyPath: Iterable<any>
Returns boolean

hashCode

hashCode(): number

Returns number

merge

merge(collections: Array<Partial<TProps> | Iterable<[string, any]>>): this

Parameters
- Rest collections: Array<Partial<TProps> | Iterable<[string, any]>>
Returns this

mergeDeep

mergeDeep(collections: Array<Partial<TProps> | Iterable<[string, any]>>): this

Parameters
- Rest collections: Array<Partial<TProps> | Iterable<[string, any]>>
Returns this

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, collections: Array<any>): this

Parameters
- keyPath: Iterable<any>
- Rest collections: Array<any>
Returns this

mergeDeepWith

mergeDeepWith(merger: function, collections: Array<Partial<TProps> | Iterable<[string, any]>>): this

Parameters
- merger: function
  - - Parameters
      - oldVal: any
      - newVal: any
      - key: any
      Returns any
- Rest collections: Array<Partial<TProps> | Iterable<[string, any]>>
Returns this

mergeIn

mergeIn(keyPath: Iterable<any>, collections: Array<any>): this

Parameters
- keyPath: Iterable<any>
- Rest collections: Array<any>
Returns this

mergeWith

mergeWith(merger: function, collections: Array<Partial<TProps> | Iterable<[string, any]>>): this

Parameters
- merger: function
  - - Parameters
      - oldVal: any
      - newVal: any
      - key: keyof TProps
      Returns any
- Rest collections: Array<Partial<TProps> | Iterable<[string, any]>>
Returns this

remove

remove(key: K): this

Type parameters
- K: keyof TProps
Parameters
- key: K
Returns this

removeIn

removeIn(keyPath: Iterable<any>): this

Parameters
- keyPath: Iterable<any>
Returns this

set

set(key: K, value: TProps[K]): this

Type parameters
- K: keyof TProps
Parameters
- key: K
- value: TProps[K]
Returns this

setDateOrigin

setDateOrigin(dateOrigin: Date | undefined): this

Parameters
- dateOrigin: Date | undefined
Returns this

New DateTimeTickStrategy object.

setFormattingDay

setFormattingDay(greatTickFormattingOptions: DateTimeFormatter, majorTickFormattingOptions: DateTimeFormatter, minorTickFormattingOptions: DateTimeFormatter): this

Parameters
- greatTickFormattingOptions: DateTimeFormatter
- majorTickFormattingOptions: DateTimeFormatter
- minorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setFormattingDecade

setFormattingDecade(majorTickFormattingOptions: DateTimeFormatter, minorTickFormattingOptions: DateTimeFormatter): this

Parameters
- majorTickFormattingOptions: DateTimeFormatter
- minorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setFormattingHour

setFormattingHour(greatTickFormattingOptions: DateTimeFormatter, majorTickFormattingOptions: DateTimeFormatter, minorTickFormattingOptions: DateTimeFormatter): this

Parameters
- greatTickFormattingOptions: DateTimeFormatter
- majorTickFormattingOptions: DateTimeFormatter
- minorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setFormattingMilliSecond

setFormattingMilliSecond(greatTickFormattingOptions: DateTimeFormatter, majorTickFormattingOptions: DateTimeFormatter): this

Parameters
- greatTickFormattingOptions: DateTimeFormatter
- majorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setFormattingMinute

setFormattingMinute(greatTickFormattingOptions: DateTimeFormatter, majorTickFormattingOptions: DateTimeFormatter, minorTickFormattingOptions: DateTimeFormatter): this

Parameters
- greatTickFormattingOptions: DateTimeFormatter
- majorTickFormattingOptions: DateTimeFormatter
- minorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setFormattingMonth

setFormattingMonth(greatTickFormattingOptions: DateTimeFormatter, majorTickFormattingOptions: DateTimeFormatter, minorTickFormattingOptions: DateTimeFormatter): this

Parameters
- greatTickFormattingOptions: DateTimeFormatter
- majorTickFormattingOptions: DateTimeFormatter
- minorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setFormattingSecond

setFormattingSecond(greatTickFormattingOptions: DateTimeFormatter, majorTickFormattingOptions: DateTimeFormatter): this

Parameters
- greatTickFormattingOptions: DateTimeFormatter
- majorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setFormattingWeek

setFormattingWeek(greatTickFormattingOptions: DateTimeFormatter, majorTickFormattingOptions: DateTimeFormatter, minorTickFormattingOptions: DateTimeFormatter): this

Parameters
- greatTickFormattingOptions: DateTimeFormatter
- majorTickFormattingOptions: DateTimeFormatter
- minorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setFormattingYear

setFormattingYear(majorTickFormattingOptions: DateTimeFormatter, minorTickFormattingOptions: DateTimeFormatter): this

Parameters
- majorTickFormattingOptions: DateTimeFormatter
- minorTickFormattingOptions: DateTimeFormatter
Returns this

New DateTimeTickStrategy object.

setGreatTickStyle

setGreatTickStyle(value: TickStyle | ImmutableMutator<TickStyle>): this

Parameters
- value: TickStyle | ImmutableMutator<TickStyle>
Returns this

New DateTimeTickStrategy object.

setIn

setIn(keyPath: Iterable<any>, value: any): this

Parameters
- keyPath: Iterable<any>
- value: any
Returns this

setLocale

setLocale(locale: string | undefined): this

Parameters
- locale: string | undefined
Returns this

New DateTimeTickStrategy object.

setMajorTickStyle

setMajorTickStyle(value: VisibleTicks | ImmutableMutator<VisibleTicks>): this

Parameters
- value: VisibleTicks | ImmutableMutator<VisibleTicks>
Returns this

New DateTimeTickStrategy object.

setMinorTickStyle

setMinorTickStyle(value: TickStyle | ImmutableMutator<VisibleTicks>): this

Parameters
- value: TickStyle | ImmutableMutator<VisibleTicks>
Returns this

New DateTimeTickStrategy object.

toJS

toJS(): object

Returns object

toJSON

toJSON(): TProps

Returns TProps

toObject

toObject(): TProps

Returns TProps

toSeq

toSeq(): Keyed<keyof TProps, TProps[keyof TProps]>

Returns Keyed<keyof TProps, TProps[keyof TProps]>

update

update(key: K, updater: function): this

Type parameters
- K: keyof TProps
Parameters
- key: K
- updater: function
  - - Parameters
      - value: TProps[K]
      Returns TProps[K]
Returns this

updateIn

updateIn(keyPath: Iterable<any>, updater: function): this

Parameters
- keyPath: Iterable<any>
- updater: function
  - - Parameters
      - value: any
      Returns any
Returns this

wasAltered

wasAltered(): boolean

Returns boolean

withMutations

withMutations(mutator: function): this

Parameters
- mutator: function
  - - Parameters
      - mutable: this
      Returns any
Returns this

Static Factory

Factory(values: Partial<TProps> | Iterable<[string, any]>): Record<TProps> & Readonly<TProps>

Type parameters
- TProps: Object
Parameters
- Optional values: Partial<TProps> | Iterable<[string, any]>
Returns Record<TProps> & Readonly<TProps>

Static Record

Record(defaultValues: TProps, name: undefined | string): Factory<TProps>

Type parameters
- TProps
Parameters
- defaultValues: TProps
- Optional name: undefined | string
Returns Factory<TProps>

Static getDescriptiveName

getDescriptiveName(record: Record<any>): string

Parameters
- record: Record<any>
Returns string

Static isRecord

isRecord(maybeRecord: any): boolean

Parameters
- maybeRecord: any
Returns boolean