Skip to content

Latest commit

 

History

History
185 lines (144 loc) · 10.4 KB

line_chart.md

File metadata and controls

185 lines (144 loc) · 10.4 KB

LineChart

How to use

LineChart(
  LineChartData(
    // read about it in the below section
  ),
);

LineChartData

PropName Description default value
lineBarsData list of LineChartBarData to show the chart's lines, they stack and be drawn on top of each other []
titlesData check the FlTitlesData FlTitlesData()
extraLinesData ExtraLinesData object to hold drawing details of extra horizontal and vertical lines.
lineTouchData LineTouchData holds the touch interactivity details LineTouchData()
showingTooltipIndicators show the tooltip based on provided position(x), and list of [LineBarSpot] {}
gridData check the FlGridData FlGridData()
borderData check the FlBorderData FlBorderData()
minX gets minimum x of x axis, if null, value will read from the input lineBars null
maxX gets maximum x of x axis, if null, value will read from the input lineBars null
minY gets minimum y of y axis, if null, value will read from the input lineBars null
maxY gets maximum y of y axis, if null, value will read from the input lineBars null
clipToBorder clip the chart to the border (prevent drawing outside the border) false
backgroundColor a background color which is drawn behind th chart null

LineChartBarData

PropName Description default value
show determines to show or hide the bar line true
spots list of FlSpot's x and y coordinates that the line go through it []
colors colors the line, if multiple colors provided it will be gradient [Colors.redAccent]
colorStops gets the stop positions of the gradient color, Read More null
gradientFrom determines start of the gradient, each number should be between 0 and 1, Read More Offset(0, 0)
gradientTo determines end of the gradient, each number should be between 0 and 1, Read More Offset(1, 0)
barWidth gets the stroke width of the line bar 2.0
isCurved curves the corners of the line on the spot's positions false
curveSmoothness smoothness radius of the curve corners (works when isCurved is true) 0.35
preventCurveOverShooting prevent overshooting when draw curve line on linear sequence spots, check this issue false
isStrokeCapRound determines whether start and end of the bar line is Qubic or Round false
belowBarData check the BarAreaData BarAreaData
aboveBarData check the BarAreaData BarAreaData
dotData check the FlDotData FlDotData()
showingIndicators show indicators based on provided indexes []

BarAreaData

PropName Description default value
show determines to show or hide the below, or above bar area false
colors colors the below, or above bar area, if multiple colors provided it will be gradient [Colors.blueGrey]
gradientFrom determines start of the gradient, each number should be between 0 and 1, Read More Offset(0, 0)
gradientTo determines end of the gradient, each number should be between 0 and 1, Read More Offset(1, 0)
gradientColorStops gets the stop positions of the gradient color, Read More null
spotsLine draw a line from each spot the the bottom, or top of the chart BarAreaSpotsLine()
cutOffY cut the drawing below or above area to this y value (set applyCutOffY true if you want to set it) null
applyCutOffY determines should or shouldn't apply cutOffY (scutOffY should be provided) false

BarAreaSpotsLine

PropName Description default value
show determines show or hide the below, or above spots line true
flLineStyle a FlLine object that determines style of the line [Colors.blueGrey]
checkToShowSpotLine a function to determine whether to show or hide the below or above line on the given spot showAllSpotsBelowLine

FlDotData

PropName Description default value
show determines to show or hide the dots true
dotColor colors the showing dot Colors.blue
dotSize size of showing dot 4.0
checkToShowDot a function to determine whether to show or hide the dot on the given spot showAllDots

HorizontalLine

PropName Description default value
x draw straight line from bottom to top of the chart with dynamic x value null
color color of the line Colors.black
strokeWidth strokeWidth of the line 2

VerticalLine

PropName Description default value
x draw straight line from left to right of the chart with dynamic y value null
color color of the line Colors.black
strokeWidth strokeWidth of the line 2

ExtraLinesData

PropName Description default value
showHorizontalLines determines to show or hide the horizontal lines false
horizontalLines list of HorizontalLine to draw on the chart []
showVerticalLines determines to show or hide the vertical lines false
verticalLines list of VerticalLine to draw on the chart []
PropName Description default value
enabled determines to enable or disable touch behaviors true
enableNormalTouch set it false if you just want to handle long press true
touchTooltipData a LineTouchTooltipData, that determines how show the tooltip on top of touched spots (appearance of the showing tooltip bubble) LineTouchTooltipData
getTouchedSpotIndicator a callback that retrieves list of TouchedSpotIndicatorData by the given list of LineBarSpot for showing the indicators on touched spots defaultTouchedIndicators
touchSpotThreshold the threshold of the touch accuracy 10
handleBuiltInTouches set this true if you want the built in touch handling (show a tooltip bubble and an indicator on touched spots) true
touchCallback listen to this callback to retrieve touch events, it gives you a LineTouchResponse null

LineTouchTooltipData

PropName Description default value
tooltipBgColor background color of the tooltip bubble Colors.white
tooltipRoundedRadius background corner radius of the tooltip bubble 4
tooltipPadding padding of the tooltip EdgeInsets.symmetric(horizontal: 16, vertical: 8)
tooltipBottomMargin bottom margin of the tooltip (to the top of most top spot) 16
maxContentWidth maximum width of the tooltip (if a text row is wider than this, then the text breaks to a new line 120
getTooltipItems a callback that retrieve list of LineTooltipItem by the given list of LineBarSpot defaultLineTooltipItem

LineTooltipItem

PropName Description default value
text text string of each row in the tooltip bubble null
textStyle TextStyle of the showing text row null

TouchedSpotIndicatorData

PropName Description default value
indicatorBelowLine a FlLine to show the below line indicator on the touched spot null
touchedSpotDotData a FlDotData to show a dot indicator on the touched spot null

LineBarSpot

PropName Description default value
bar the LineChartBarData that contains a spot null
barIndex index of the target LineChartBarData inside LineChartData null
spotIndex index of the target FlSpot inside LineChartBarData null

LineTouchResponse

you can listen to touch behaviors stream and retrieve this object when any touch action happend.
PropName Description default value
lineBarSpots a list of LineBarSpot null
touchInput a FlTouchInput that is the touch behaviour null

some samples


Sample 1 (Source Code)

Sample 2 (Source Code)

Sample 3 (Source Code)

Sample 4 (Source Code)

Sample 5 (Source Code)

Sample 6 - Reversed (Source Code)