Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ChartBase
    • ChartSimple

Index

Properties

dataComponent?: string

The dataComponent prop defines which dataComponent function (that renders specific component) to pass to the Victory chart. The value has to be in the name one of the passed functions in the functions list under the dataComponent key.

id: number

The id props specifies the unique id for the given element in the schema. Used in the library to reference the element in the schema.

kind: simple

The kind of the chart. Always simple.

name?: string

The name prop defines the name by which the chart will be referenced. Usually you want to leave this prop empty, since by default the library fills the name from the data set.

onClick?: string

The onClick prop defines which on click function will be used when the data point is clicked. The value has to be in the name one of the passed functions in the functions list under the onClick key. The default function does nothing.

default

'default'

see

ChartWrapperTooltipProps

see

ChartOnClickFunction

see

ChartInterface.functions

parent: number

The parent prop specifies which element is the parent for the current element. In case of null the element is top level element.

The props defined the props that are directly passed to the chart element. The are not owerwriting the extra props that are added by the library.

The tooltip prop if defined creates a tooltip for the chart. All the porps inside the tooltip prop are used to controll the tooltip.

example

tooltip: {} - the chart and the data will show up in tootlip(s).

example

tooltip: { standalone: true } - the chart will have a standalone tooltip.

type: ChartType

The type prop defines which chart type will be rendered.

Generated using TypeDoc