Skip to main content

Goal Spec

Defines a simple goal/guage/bullet chart.

danger

This spec has been deprecated and replaced by the BulletGraph spec. This will eventually be entirely removed from the library in future versions.

Overview

Compatible Specs

Goal is a standalone spec and cannot be combined with other specs except the Settings specs.

Overrides

  • specType -> SpecType.Series
  • chartType -> ChartType.Goal

Props

All props can be found via GoalProps type.

Spec Props

Inherits Spec props

specType

  • Type: specType: typeof SpecType.Series

chartType

  • Type: chartType: typeof ChartType.Goal

subtype

  • Type: subtype: GoalSubtype

base

  • Type: base: number

target

  • Type: target?: number

actual

  • Type: actual: number

bands

  • Type: bands?: number | number[]

Array of discrete band intervals or approximate number of desired bands

ticks

  • Type: ticks?: number | number[]

Array of discrete tick values or approximate number of desired ticks

domain

  • Type: domain: GoalDomainRange

Domain of goal charts. Limits every value to within domain.

bandFillColor

  • Type: bandFillColor: BandFillColorAccessor

tickValueFormatter

  • Type: tickValueFormatter: GoalLabelAccessor

labelMajor

  • Type: labelMajor: string | GoalLabelAccessor

labelMinor

  • Type: labelMinor: string | GoalLabelAccessor

centralMajor

  • Type: centralMajor: string | GoalLabelAccessor

centralMinor

  • Type: centralMinor: string | GoalLabelAccessor

angleStart

  • Type: angleStart: number

angleEnd

  • Type: angleEnd: number

bandLabels

  • Type: bandLabels: string[]

tooltipValueFormatter

  • Type: tooltipValueFormatter: ValueFormatter