Skip to main content

Goal

@elastic/charts • Exports


@elastic/charts / Goal

Function: Goal()

Goal(props): null

Add Goal spec to chart

Parameters​

• props: SFProps<GoalSpec, "chartType" | "specType", "base" | "actual" | "bandFillColor" | "tickValueFormatter" | "labelMajor" | "labelMinor" | "centralMajor" | "centralMinor" | "angleStart" | "angleEnd" | "bandLabels" | "tooltipValueFormatter", SFOptionalKeys<GoalSpec, "chartType" | "specType", "base" | "actual" | "bandFillColor" | "tickValueFormatter" | "labelMajor" | "labelMinor" | "centralMajor" | "centralMinor" | "angleStart" | "angleEnd" | "bandLabels" | "tooltipValueFormatter">, SFRequiredKeys<GoalSpec, "chartType" | "specType", "base" | "actual" | "bandFillColor" | "tickValueFormatter" | "labelMajor" | "labelMinor" | "centralMajor" | "centralMinor" | "angleStart" | "angleEnd" | "bandLabels" | "tooltipValueFormatter", SFOptionalKeys<GoalSpec, "chartType" | "specType", "base" | "actual" | "bandFillColor" | "tickValueFormatter" | "labelMajor" | "labelMinor" | "centralMajor" | "centralMinor" | "angleStart" | "angleEnd" | "bandLabels" | "tooltipValueFormatter">>>

Returns​

null

Deprecated​

please use Bullet spec instead

Source​

packages/charts/src/chart_types/goal_chart/specs/index.ts:101


Generated using typedoc-plugin-markdown and TypeDoc