Class: Footer

Footer

A UI Footer instance. Turns on an area either above or below the chart to accommodate additional UI interaction. The footer has a left and right side, and each side is populated with UI elements which are configured just like the buttons in the buttons section. In the event the chart is too narrow to accommodate all the elements on both the left and right sides on one line, the footer is broken into two lines. Configuration is done via the CompactChart configuration FooterConfig.

Since:

  • 9.4.0

Members

<readonly> items :Record.<string, Button>

Buttons configured for this footer, separated into left and right sub-objects.

Type:
Since:

  • 9.4.0

Type Definitions

FooterConfig

UI footer menu configuration. Configures a footer for the chart that contains buttons to control various features. These buttons are configured the same way as defined in ButtonConfig and leverage the same functionality.

Type:
Properties:
Name Type Argument Default Description
onTop boolean <optional>

Set to true to place the footer on the top of the chart as oppsoed to the bottom.
outer FooterSide <optional>
 'right'

Indicates which side of the footer falls to the outside of the chart when the fotter is narrowed to the point where not everything fits on one line.
backgroundColor string <optional>

Background color of footer.
color string <optional>

Font color for footer.
borderColor string <optional>

Color of border between left and right sides of footer.
fontSize string <optional>

Font size of footer text.
fontFamily string <optional>

Font family of footer text.
fontStyle string <optional>

Font style of footer text (e.g. italic).
fontWeight string <optional>

Font weight of footer text (e.g. bold).
left Record.<string, ButtonConfig> <optional>

Button configurations for left side of footer.
right Record.<string, ButtonConfig> <optional>

Button configurations for right side of footer.
Since:

  • 9.4.0

FooterSide

Possible values of the FooterConfig object's outer property.

Type:
  • 'left' | 'right'
Since:

  • 9.4.0