Graph Legend: Fix variables named legend

[hoorayimhelping]

Background

Until this epic, legend was used interchangeably with tooltip. We currently have a bunch of concepts and variables in giraffe, the UI and even the backend storage of the UI that are tightly coupled to the concept of a legend. Keeping this nomenclature around will cause confusion, bugs, and will require constant explanation.

Acceptance Criteria

• Create a new concept called StaticLegend
• Rename Legend to Tooltip
• Mark the Legend concept as deprecated
• Come up with a plan to remove Legend

[TCL735]

Some thoughts on this...

The interface for static legend has basically the same properties (with width and height added) as the current legend properties seen here:

One way to handle the renaming would be to keep the existing properties, and make them apply to both the Tooltip and the Static Legend. And then introduce a new property (object) for each of them that overrides the specific properties when included. The new configuration would look something like below. Properties are omitted in tooltip and staticLegend when not overridden.

legendFont: string,
legendFontColor: string,
legendFontBrightColor: string,
legendBackgroundColor: string,
legendColorizeRows: boolean,
legendBorder: string,
legendCursor: string,
legendOpacity: number,
legendOrientationThreshold: number,
tooltip: {
  font: string
  fontColor: string
  fontBrightColor: string
  backgroundColor: string
  colorizeRows: boolean
  border: string
  cursor: string
  opacity: number
  orientationThreshold: number
},
staticLegend: {
  width: number
  height: number
  font: string
  fontColor: string
  fontBrightColor: string
  backgroundColor: string
  colorizeRows: boolean
  border: string
  cursor: string
  opacity: number
  orientationThreshold: number
}

The goal would be to allow the user to use the same styling without repeating the configuration, and differentiating the styling only as desired.

[TCL735]

There is a lot of code to track down in multiple repositories. The timing of the code changes must be carefully orchestrated. Marking this as a 5-pointer.

[TCL735]

Much of the work to get consistency with naming in Giraffe will be done here: #547

[TCL735]

Still to come: ensure the ui repository has consistent naming for the tooltip and static legend

[TCL735]

Various PRs across many repositories have done a lot to address this issue.

influxdata/openapi#12
influxdata/openapi#41

https://github.com/influxdata/idpe/pull/10377
https://github.com/influxdata/idpe/pull/10565

influxdata/influxdb#21218
influxdata/influxdb#21364

#510
#547
#555
#566
#572

[TCL735]

This issue is a side effect and will resolve itself as the Static Legend work is completed which is tracked by other issues.

Closing this.