Interface OnScreenMenuCustomButtonParams

Interface to describe parameters that are used to construct a custom button for the On-Screen Menu.

Hierarchy

  • OnScreenMenuCustomButtonParams

Properties

action color? dimensions? icon? label? opacity? shape?

Properties

action

action: ((chart: ChartXY<PointMarker, UIBackground>) => void)

Type declaration

Optional color

color?: string

Optional color value for this button. If no value is specified, the color will be chosen from the theme.

Optional dimensions

dimensions?: OnScreenMenuDimensions

Optional icon

icon?: string

Path to an icon that this button will display.

Optional label

label?: string

Optional label to be displayed on the button.

Optional opacity

opacity?: string

Optional opacity for the button. Accepts a value between 0 and 1, were 0 is transparent and 1 is opaque.

Optional shape

shape?: OnScreenMenuButtonShape

Optional value for the shape of the button.

Settings

Member Visibility

Theme