class anychart.scales.GanttDateTime Improve this Doc

The GanttDateTime class contains methods for configuring DateTime scale on the Gantt chart.

Methods Overview

Specific settings
fiscalYearStartMonth()	Scale fiscal year start month.
getRange()	Gets minimum and maximum visible dates set for a scale.
getTotalRange()	Gets total minimum and maximum dates set for a scale.
inverseTransform()	Processes reverse transformation of the ratio backward to value.
maxTicksCount()	Maximum ticks count.
maximum()	Scale maximum.
maximumGap()	Getter for the maximum gap.
minimum()	Scale minimum.
minimumGap()	Getter for the minimum gap.
softMaximum()	Soft maximum settings.
softMinimum()	Soft minimum settings.
transform()	Transforms values to ratio.
weeksCycleMonthly()	Whether weeks end with month.
weeksEndWithYear()	Whether weeks end with year.
zoomLevels()	Zoom level settings.

Methods Description

fiscalYearStartMonth

fiscalYearStartMonth()Since version 8.7.0

Getter for the scale fiscal year start month.

Returns:

number - Numeric month representation (1 is January, 12 is December)

fiscalYearStartMonth(value)Since version 8.7.0

Setter for the scale fiscal year start month.

Params:

Name	Type	Description
value	number	Scale fiscal year start month value to set. 1 is January, 12 is December, etc.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample

getRange

getRange()Since version 8.1.0

Gets minimum and maximum visible dates set for a scale.

Returns:

Object.<string, number> - An object with min and max keys.

Try it:

Usage sample

getTotalRange

getTotalRange()Since version 8.1.0

Gets total minimum and maximum dates set for a scale.

Returns:

Object.<string, number> - An object with min and max keys.

Try it:

Usage sample

inverseTransform

inverseTransform(ratio)Since version 8.2.0

Processes reverse transformation of the ratio backward to value.

Params:

Name	Type	Description
ratio	number	Ratio to transform.

Returns:

number - Ratio transformed to timestamp.

Try it:

Usage sample

maxTicksCount

maxTicksCount()Since version 8.7.1

Getter for the scale maximum ticks count.

Returns:

number - The scale maximum ticks count.

See listing

var scale = chart.xScale();
var count = scale.maxTicksCount();

maxTicksCount(count)Since version 8.7.1

Setter for the scale maximum ticks count.

Params:

Name	Type	Default	Description
count	number	200	Scale maximum ticks count value to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample

maximum

maximum()Since version 7.12.0

Getter for the scale maximum.

Returns:

number - The scale maximum value.

See listing

var scale = chart.xScale();
var maximum = scale.maximum();

maximum(maximum)Since version 7.12.0

Setter for the scale maximum.

Params:

Name	Type	Description
maximum	number	Scale maximum value to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample

maximumGap

maximumGap()Since version 8.8.0

Getter for the maximum gap. NOTE: For backward compatibility:
- if the gap was set as 'pixel gap', method returns an object defined as anychart.scales.GanttDateTime.Gap.
- if the gap was set as 'percent gap', method returns a number representing a ratio-gap as it was before feature implementation.

Returns:

number | anychart.scales.GanttDateTime.Gap - The minimum gap value.

maximumGap(gap, treatAsPixels)Since version 8.8.0

Setter for the maximum gap.

Params:

Name	Type	Description
gap	number \| anychart.scales.GanttDateTime.Gap	Gap value to be set. Can take numeric value or an object defined as anychart.scales.GanttDateTime.Gap.
treatAsPixels	boolean	Whether to treat first parameter numeric value as pixels.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

minimum

minimum()Since version 7.12.0

Getter for the scale minimum.

Returns:

number - The scale minimum value.

See listing

var scale = chart.xScale();
var minimum = scale.minimum();

minimum(minimum)Since version 7.12.0

Setter for the scale minimum.

Params:

Name	Type	Description
minimum	number	Scale minimum value to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample

minimumGap

minimumGap()Since version 8.8.0

Getter for the minimum gap.
NOTE: For backward compatibility:
- if the gap was set as 'pixel gap', method returns an object defined as anychart.scales.GanttDateTime.Gap.
- if the gap was set as 'percent gap', method returns a number representing a ratio-gap as it was before feature implementation.

Returns:

number | anychart.scales.GanttDateTime.Gap - The minimum gap value.

minimumGap(gap, treatAsPixels)Since version 8.8.0

Setter for the minimum gap.

Params:

Name	Type	Description
gap	number \| anychart.scales.GanttDateTime.Gap	Gap value to be set. Can take numeric value or an object defined as anychart.scales.GanttDateTime.Gap.
treatAsPixels	boolean	Whether to treat first parameter numeric value as pixels.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

softMaximum

softMaximum()Since version 7.12.0

Getter for the scale soft maximum.

Returns:

number - The soft maximum value.

See listing

var scale = chart.xScale();
var softMax = scale.softMaximum();

softMaximum(maximum)Since version 7.12.0

Setter for the scale soft maximum.

Params:

Name	Type	Description
maximum	number	Soft maximum value to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample

softMinimum

softMinimum()Since version 7.12.0

Getter for the scale soft minimum.

Returns:

number - The soft minimum value.

See listing

var scale = chart.xScale();
var softMin = scale.softMinimum();

softMinimum(minimum)Since version 7.12.0

Setter for the scale soft minimum.

Params:

Name	Type	Description
minimum	number	Soft minimum value to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample

transform

transform(value)Since version 8.2.0

Transforms values to ratio.

Params:

Name	Type	Description
value	*	Value to transform.

Returns:

number - Value to ratio.

Try it:

Usage sample

weeksCycleMonthly

weeksCycleMonthly()

Getter for the scale behavior regarding weeks limitation within a month boundaries.

Returns:

boolean - Current value.

Try it:

Usage sample

weeksCycleMonthly(value)

Setter for the scale behavior regarding weeks limitation within a month boundaries.

Params:

Name	Type	Description
value	boolean	Whether to enable week alignment with month boundaries.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample

weeksEndWithYear

weeksEndWithYear()

Getter for the scale behavior regarding weeks limitation within a year.

Returns:

boolean - Current value.

Try it:

Usage sample

weeksEndWithYear(value)

Setter for the scale behavior regarding weeks limitation within a year.

Params:

Name	Type	Description
value	boolean	Whether to enable week alignment with year boundaries.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample

zoomLevels

zoomLevels()Since version 8.2.0

Getter for zoom levels settings.

Returns:

anychart.scales.GanttDateTime.ZoomLevelsSettings - Zoom levels settings

zoomLevels(settings)Since version 8.2.0

Setter for zoom levels settings.
The method sets the sets of labels by which the header is built.

Params:

Name	Type	Description
settings	anychart.scales.GanttDateTime.ZoomLevelsSettings	Zoom levels settings to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

Try it:

Usage sample