DateTimeAxis class

The date-time axis uses a date-time scale and displays date-time values as axis labels in the specified format.

The range of the Date time can be customized by minimum and maximum properties, also change data label format by the dateFormat.

Provides the options for range padding, interval, date format for customizing the appearance.

Inheritance

• Object
• DiagnosticableTree
• Widget
• RenderObjectWidget
• LeafRenderObjectWidget
• ChartAxis
• DateTimeAxis

Constructors

DateTimeAxis({Key? key, String? name, bool isVisible = true, AxisTitle title = const AxisTitle(), AxisLine axisLine = const AxisLine(), ChartRangePadding rangePadding = ChartRangePadding.auto, AxisLabelIntersectAction labelIntersectAction = AxisLabelIntersectAction.hide, ChartDataLabelPosition labelPosition = ChartDataLabelPosition.outside, TickPosition tickPosition = TickPosition.outside, EdgeLabelPlacement edgeLabelPlacement = EdgeLabelPlacement.none, double initialZoomFactor = 1, double initialZoomPosition = 0, bool enableAutoIntervalOnZooming = true, int labelRotation = 0, bool isInversed = false, bool opposedPosition = false, int minorTicksPerInterval = 0, int maximumLabels = 3, double? plotOffset, double? plotOffsetStart, double? plotOffsetEnd, MajorTickLines majorTickLines = const MajorTickLines(), MinorTickLines minorTickLines = const MinorTickLines(), MajorGridLines majorGridLines = const MajorGridLines(), MinorGridLines minorGridLines = const MinorGridLines(), TextStyle? labelStyle, DateFormat? dateFormat, DateTimeIntervalType intervalType = DateTimeIntervalType.auto, InteractiveTooltip interactiveTooltip = const InteractiveTooltip(), String? labelFormat, DateTime? minimum, DateTime? maximum, LabelAlignment labelAlignment = LabelAlignment.center, double? interval, DateTime? initialVisibleMinimum, DateTime? initialVisibleMaximum, dynamic crossesAt, String? associatedAxisName, bool placeLabelsNearAxisLine = true, List<PlotBand> plotBands = const <PlotBand>[], RangeController? rangeController, int? desiredIntervals, double? maximumLabelWidth, double? labelsExtent, DateTimeIntervalType autoScrollingDeltaType = DateTimeIntervalType.auto, int? autoScrollingDelta, double borderWidth = 0.0, Color? borderColor, AxisBorderType axisBorderType = AxisBorderType.rectangle, MultiLevelLabelStyle multiLevelLabelStyle = const MultiLevelLabelStyle(), MultiLevelLabelFormatterCallback? multiLevelLabelFormatter, List<DateTimeMultiLevelLabel>? multiLevelLabels, AutoScrollingMode autoScrollingMode = AutoScrollingMode.end, ChartLabelFormatterCallback? axisLabelFormatter, dynamic onRendererCreated(DateTimeAxisController)?})

Creating an argument constructor of DateTimeAxis class.

const

Properties

anchorRangeToVisiblePoints → bool

Determines the value axis range, based on the visible data points or based on the overall data points available in chart.

final, inherited

associatedAxisName → String?

Axis line crossed on mentioned axis name, and applicable for plot band also.

final, inherited

autoScrollingDelta → int?

The number of data points to be visible always in the chart.

final, inherited

autoScrollingDeltaType → DateTimeIntervalType

Defines the type of delta value in the DateTime axis.

final

autoScrollingMode → AutoScrollingMode

Determines whether the axis should be scrolled from the start position or end position.

final, inherited

axisBorderType → AxisBorderType

Border type of the axis label.

final, inherited

axisLabelFormatter → ChartLabelFormatterCallback?

Called while rendering each axis label in the chart.

final, inherited

axisLine → AxisLine

Customizes the appearance of the axis line. The axis line is visible by default.

final, inherited

borderColor → Color?

Border color of the axis label.

final, inherited

borderWidth → double

Border width of the axis label.

final, inherited

crossesAt → dynamic

Customization to place the axis crossing on another axis based on the value.

final, inherited

dateFormat → DateFormat?

Formats the date-time axis labels. The default data-time axis label can be formatted with various built-in date formats.

final

desiredIntervals → int?

The number of intervals in an axis.

final, inherited

edgeLabelPlacement → EdgeLabelPlacement

Position of the edge labels.

final, inherited

enableAutoIntervalOnZooming → bool

Enables or disables the automatic interval while zooming.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

initialVisibleMaximum → DateTime?

The maximum visible value of the axis. The axis is rendered from this value initially, and it applies only during load time. The value will not be updated when zooming or panning.

final

initialVisibleMinimum → DateTime?

The minimum visible value of the axis. The axis is rendered from this value initially, and it applies only during load time. The value will not be updated when zooming or panning.

final

initialZoomFactor → double

Defines the percentage of the visible range from the total range of axis values. It applies only during load time and the value will not be updated when zooming or panning.

final, inherited

initialZoomPosition → double

Defines the zoom position for the actual range of the axis. It applies only during load time and the value will not be updated when zooming or panning.

final, inherited

interactiveTooltip → InteractiveTooltip

Customizes the crosshair and selection zooming tooltip. Tooltip displays the current axis value based on the crosshair position/selectionZoomRect position at an axis.

final, inherited

interval → double?

Axis interval value.

final, inherited

intervalType → DateTimeIntervalType

Customizes the date-time axis intervals. Intervals can be set to days, hours, milliseconds, minutes, months, seconds, years, and auto. If it is set to auto, interval type will be decided based on the data.

final

isInversed → bool

Inverts the axis.

final, inherited

isVisible → bool

Toggles the visibility of the axis.

final, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

labelAlignment → LabelAlignment

Alignment of the labels.

final, inherited

labelFormat → String?

Formats the date time-axis labels. The labels can be customized by adding desired text to prefix or suffix.

final

labelIntersectAction → AxisLabelIntersectAction

Axis labels intersecting action.

final, inherited

labelPosition → ChartDataLabelPosition

Position of the labels.

final, inherited

labelRotation → int

Angle for axis labels. The axis labels can be rotated to any angle.

final, inherited

labelsExtent → double?

Specifies the fixed width for the axis labels. This width represents the space between axis line and axis title.

final, inherited

labelStyle → TextStyle?

Customizes the appearance of the axis labels.

final, inherited

majorGridLines → MajorGridLines

Customizes the appearance of the major grid lines.

final, inherited

majorTickLines → MajorTickLines

Customizes the appearance of the major tick lines.

final, inherited

maximum → DateTime?

Maximum value of the axis. The axis will end at this date.

final

maximumLabels → int

The maximum number of labels to be displayed in an axis in 100 logical pixels.

final, inherited

maximumLabelWidth → double?

Specifies maximum text width for axis labels.

final, inherited

minimum → DateTime?

Minimum value of the axis. The axis will start from this date.

final

minorGridLines → MinorGridLines

Customizes the appearance of the minor grid lines.

final, inherited

minorTickLines → MinorTickLines

Customizes the appearance of the minor tick lines.

final, inherited

minorTicksPerInterval → int

Interval of the minor ticks.

final, inherited

multiLevelLabelFormatter → MultiLevelLabelFormatterCallback?

Called while rendering each multi-level label.

final, inherited

multiLevelLabels → List<DateTimeMultiLevelLabel>?

Provides the option to group the axis labels. You can customize the start, end value of a multi-level label, text, and level of the multi-level labels.

final

multiLevelLabelStyle → MultiLevelLabelStyle

Customize the multi-level label’s border color, width, type, and text style such as color, font size, etc.

final, inherited

name → String?

Name of an axis.

final, inherited

onRendererCreated → dynamic Function(DateTimeAxisController)?

final

opposedPosition → bool

Opposes the axis position.

final, inherited

placeLabelsNearAxisLine → bool

Consider to place the axis label respect to near axis line.

final, inherited

plotBands → List<PlotBand>

Render the plot band in axis.

final, inherited

plotOffset → double?

The plotOffset property is used to offset the rendering of the axis at start and end position.

final, inherited

plotOffsetEnd → double?

The plotOffsetEnd property is used to offset the rendering of the axis at end position.

final, inherited

plotOffsetStart → double?

The plotOffsetStart property is used to offset the rendering of the axis at start position.

final, inherited

rangeController → RangeController?

The rangeController property is used to set the maximum and minimum values for the chart in the viewport. In the minimum and maximum properties of the axis, you can specify the minimum and maximum values with respect to the entire data source. In the visibleMinimum and visibleMaximum properties, you can specify the values to be viewed in the viewed port i.e. range controller's start and end values respectively.

final, inherited

rangePadding → ChartRangePadding

Padding for minimum and maximum values in an axis.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tickPosition → TickPosition

Position of the tick lines.

final, inherited

title → AxisTitle

Customizes the appearance of the axis title.

final, inherited

Methods

createElement() → LeafRenderObjectElement

RenderObjectWidgets always inflate to a RenderObjectElement subclass.

inherited

createRenderer() → RenderDateTimeAxis

override

createRenderObject(BuildContext context) → RenderDateTimeAxis

Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.

override

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

didUnmountRenderObject(covariant RenderObject renderObject) → void

A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

updateRenderObject(BuildContext context, covariant RenderDateTimeAxis renderObject) → void

Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited