views/com.patrykandpatrick.vico.views.chart/BaseChartView

BaseChartView

abstract class BaseChartView<Model : ChartEntryModel> : FrameLayout, ScrollListenerHost

The base for Views that display a chart. Subclasses define a Model implementation they can handle.

Inheritors

ChartView

ComposedChartView

Properties

autoScaleUp

var autoScaleUp: AutoScaleUp

Defines whether the content of the chart should be scaled up when the dimensions are such that, at a scale factor of 1, an empty space would be visible near the end edge of the chart.

bottomAxis

var bottomAxis: AxisRenderer<AxisPosition.Horizontal.Bottom>?

The AxisRenderer for the bottom axis.

chart

var chart: Chart<Model>?

The Chart displayed by this View.

chartScrollSpec

var chartScrollSpec: ChartScrollSpec<Model>

Houses scrolling-related settings.

dispatcher

var dispatcher: CoroutineDispatcher

The CoroutineDispatcher to be used for the handling of difference animations.

elevationOverlayColor

var elevationOverlayColor: Int

The color of elevation overlays, which are applied to ShapeComponents that cast shadows.

endAxis

var endAxis: AxisRenderer<AxisPosition.Vertical.End>?

The AxisRenderer for the end axis.

entryProducer

var entryProducer: ChartModelProducer<Model>?

A ChartModelProducer can provide Model updates asynchronously.

fadingEdges

var fadingEdges: FadingEdges?

Applies a horizontal fade to the edges of the chart area for scrollable charts.

getXStep

var getXStep: (Model) -> Float?

Overrides the x step (the difference between the x values of neighboring major entries). If this is null, the default x step (ChartEntryModel.xGcd) is used.

horizontalLayout

var horizontalLayout: HorizontalLayout

Defines how the chart’s content is positioned horizontally.

isHorizontalScrollEnabled

var ~~isHorizontalScrollEnabled~~: Boolean

Whether the chart can be scrolled horizontally.

isZoomEnabled

var isZoomEnabled: Boolean

Whether the pinch-to-zoom gesture is enabled.

legend

var legend: Legend?

The legend for this chart.

marker

var marker: Marker?

The Marker for this chart.

markerVisibilityChangeListener

var markerVisibilityChangeListener: MarkerVisibilityChangeListener?

Allows for listening to marker visibility changes.

model

var model: Model?

The Model for this BaseChartView’s Chart instance (chart).

runInitialAnimation

var runInitialAnimation: Boolean

Whether to display an animation when the chart is created. In this animation, the value of each chart entry is animated from zero to the actual value.

startAxis

var startAxis: AxisRenderer<AxisPosition.Vertical.Start>?

The AxisRenderer for the start axis.

topAxis

var topAxis: AxisRenderer<AxisPosition.Horizontal.Top>?

The AxisRenderer for the top axis.

Functions

addView

open override fun addView(child: View, index: Int, params: ViewGroup.LayoutParams?)

animateScrollBy

fun animateScrollBy(getDelta: (value: Float, maxValue: Float) -> Float)

Invokes the provided function block, passing to it the current scroll amount and the maximum scroll amount, and scrolls the chart by the number of pixels returned by the function block, using a ValueAnimator. Customize the animation with setAnimatedScrollDuration and setAnimatedScrollInterpolator.

onRtlPropertiesChanged

open override fun onRtlPropertiesChanged(layoutDirection: Int)

onTouchEvent

open override fun onTouchEvent(event: MotionEvent): Boolean

onViewRemoved

open override fun onViewRemoved(child: View?)

registerScrollListener

open override fun registerScrollListener(scrollListener: ScrollListener)

removeScrollListener

open override fun removeScrollListener(scrollListener: ScrollListener)

scrollBy

fun scrollBy(getDelta: (value: Float, maxValue: Float) -> Float)

Invokes the provided function block, passing to it the current scroll amount and the maximum scroll amount, and scrolls the chart by the number of pixels returned by the function block.

setAnimatedScrollDuration

fun setAnimatedScrollDuration(durationMillis: Long)

Sets the duration (in milliseconds) of animated scrolls (animateScrollBy).

setAnimatedScrollInterpolator

fun setAnimatedScrollInterpolator(interpolator: Interpolator)

Sets the Interpolator for animated scrolls (animateScrollBy).

setDiffAnimationDuration

fun setDiffAnimationDuration(durationMillis: Long)

Sets the duration (in milliseconds) of difference animations.

setDiffAnimationInterpolator

fun setDiffAnimationInterpolator(interpolator: Interpolator)

Sets the Interpolator for difference animations.