chore: deprecate legend in favor of staticLegend (#12)

Co-authored-by: Timmy Luong <TCL735@users.noreply.github.com>
influxdata · Apr 16, 2021 · c2d3611 · c2d3611
1 parent 4db17ed
commit c2d3611
Show file tree

Hide file tree

Showing 10 changed files with 91 additions and 15 deletions.
diff --git a/contracts/cloud.yml b/contracts/cloud.yml
@@ -8806,7 +8806,6 @@ components:
         - shape
         - axes
         - colors
-        - legend
         - note
         - showNoteWhenEmpty
         - position
@@ -8837,6 +8836,8 @@ components:
           type: boolean
         axes:
           $ref: '#/components/schemas/Axes'
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         legend:
           $ref: '#/components/schemas/Legend'
         xColumn:
@@ -8907,7 +8908,6 @@ components:
         - shape
         - axes
         - colors
-        - legend
         - note
         - showNoteWhenEmpty
       properties:
@@ -8939,6 +8939,8 @@ components:
           $ref: '#/components/schemas/Axes'
         legend:
           $ref: '#/components/schemas/Legend'
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         xColumn:
           type: string
         generateXAxisTicks:
@@ -8997,7 +8999,6 @@ components:
         - shape
         - axes
         - colors
-        - legend
         - note
         - showNoteWhenEmpty
         - prefix
@@ -9031,6 +9032,8 @@ components:
           type: boolean
         axes:
           $ref: '#/components/schemas/Axes'
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         legend:
           $ref: '#/components/schemas/Legend'
         xColumn:
@@ -9425,7 +9428,6 @@ components:
         - tickPrefix
         - suffix
         - tickSuffix
-        - legend
         - decimalPlaces
       properties:
         type:
@@ -9458,6 +9460,8 @@ components:
           type: string
         tickSuffix:
           type: string
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         legend:
           $ref: '#/components/schemas/Legend'
         decimalPlaces:
@@ -9540,7 +9544,6 @@ components:
         - tickPrefix
         - suffix
         - tickSuffix
-        - legend
         - decimalPlaces
       properties:
         type:
@@ -9573,6 +9576,8 @@ components:
           type: string
         tickSuffix:
           type: string
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         legend:
           $ref: '#/components/schemas/Legend'
         decimalPlaces:
@@ -9902,9 +9907,29 @@ components:
           $ref: '#/components/schemas/Axis'
         'y':
           $ref: '#/components/schemas/Axis'
+    StaticLegend:
+      description: StaticLegend represents the options specific to the static legend
+      type: object
+      properties:
+        colorizeRows:
+          type: boolean
+        heightRatio:
+          type: number
+          format: float
+        opacity:
+          type: number
+          format: float
+        orientationThreshold:
+          type: integer
+        valueAxis:
+          type: string
+        widthRatio:
+          type: number
+          format: float
     Legend:
       description: Legend define encoding of data into a view's legend
       type: object
+      deprecated: true
       properties:
         type:
           description: The style of the legend.

diff --git a/contracts/oss.yml b/contracts/oss.yml
@@ -8855,7 +8855,6 @@ components:
         - shape
         - axes
         - colors
-        - legend
         - note
         - showNoteWhenEmpty
         - position
@@ -8886,6 +8885,8 @@ components:
           type: boolean
         axes:
           $ref: '#/components/schemas/Axes'
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         legend:
           $ref: '#/components/schemas/Legend'
         xColumn:
@@ -8956,7 +8957,6 @@ components:
         - shape
         - axes
         - colors
-        - legend
         - note
         - showNoteWhenEmpty
       properties:
@@ -8988,6 +8988,8 @@ components:
           $ref: '#/components/schemas/Axes'
         legend:
           $ref: '#/components/schemas/Legend'
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         xColumn:
           type: string
         generateXAxisTicks:
@@ -9046,7 +9048,6 @@ components:
         - shape
         - axes
         - colors
-        - legend
         - note
         - showNoteWhenEmpty
         - prefix
@@ -9080,6 +9081,8 @@ components:
           type: boolean
         axes:
           $ref: '#/components/schemas/Axes'
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         legend:
           $ref: '#/components/schemas/Legend'
         xColumn:
@@ -9474,7 +9477,6 @@ components:
         - tickPrefix
         - suffix
         - tickSuffix
-        - legend
         - decimalPlaces
       properties:
         type:
@@ -9507,6 +9509,8 @@ components:
           type: string
         tickSuffix:
           type: string
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         legend:
           $ref: '#/components/schemas/Legend'
         decimalPlaces:
@@ -9589,7 +9593,6 @@ components:
         - tickPrefix
         - suffix
         - tickSuffix
-        - legend
         - decimalPlaces
       properties:
         type:
@@ -9622,6 +9625,8 @@ components:
           type: string
         tickSuffix:
           type: string
+        staticLegend:
+          $ref: '#/components/schemas/StaticLegend'
         legend:
           $ref: '#/components/schemas/Legend'
         decimalPlaces:
@@ -9951,9 +9956,29 @@ components:
           $ref: '#/components/schemas/Axis'
         'y':
           $ref: '#/components/schemas/Axis'
+    StaticLegend:
+      description: StaticLegend represents the options specific to the static legend
+      type: object
+      properties:
+        colorizeRows:
+          type: boolean
+        heightRatio:
+          type: number
+          format: float
+        opacity:
+          type: number
+          format: float
+        orientationThreshold:
+          type: integer
+        valueAxis:
+          type: string
+        widthRatio:
+          type: number
+          format: float
     Legend:
       description: Legend define encoding of data into a view's legend
       type: object
+      deprecated: true
       properties:
         type:
           description: The style of the legend.

diff --git a/src/common/_schemas.yml b/src/common/_schemas.yml
@@ -240,6 +240,8 @@
       $ref: "./common/schemas/GeoViewProperties.yml"
     Axes:
       $ref: "./common/schemas/Axes.yml"
+    StaticLegend:
+      $ref: "./common/schemas/StaticLegend.yml"
     Legend:
       $ref: "./common/schemas/Legend.yml"
     DecimalPlaces:

diff --git a/src/common/schemas/BandViewProperties.yml b/src/common/schemas/BandViewProperties.yml
@@ -6,7 +6,6 @@
     - shape
     - axes
     - colors
-    - legend
     - note
     - showNoteWhenEmpty
   properties:
@@ -36,6 +35,8 @@
       $ref: "./Axes.yml"
     legend:
       $ref: "./Legend.yml"
+    staticLegend:
+      $ref: "./StaticLegend.yml"
     xColumn:
       type: string
     generateXAxisTicks:

diff --git a/src/common/schemas/GaugeViewProperties.yml b/src/common/schemas/GaugeViewProperties.yml
@@ -11,7 +11,6 @@
       tickPrefix,
       suffix,
       tickSuffix,
-      legend,
       decimalPlaces,
     ]
   properties:
@@ -43,6 +42,8 @@
       type: string
     tickSuffix:
       type: string
+    staticLegend:
+      $ref: "./StaticLegend.yml"
     legend:
       $ref: "./Legend.yml"
     decimalPlaces:

diff --git a/src/common/schemas/Legend.yml b/src/common/schemas/Legend.yml
@@ -1,5 +1,6 @@
   description: Legend define encoding of data into a view's legend
   type: object
+  deprecated: true
   properties:
     type:
       description: The style of the legend.

diff --git a/src/common/schemas/LinePlusSingleStatProperties.yml b/src/common/schemas/LinePlusSingleStatProperties.yml
@@ -5,7 +5,6 @@
     - shape
     - axes
     - colors
-    - legend
     - note
     - showNoteWhenEmpty
     - prefix
@@ -37,6 +36,8 @@
       type: boolean
     axes:
       $ref: "./Axes.yml"
+    staticLegend:
+      $ref: "./StaticLegend.yml"
     legend:
       $ref: "./Legend.yml"
     xColumn:

diff --git a/src/common/schemas/SingleStatViewProperties.yml b/src/common/schemas/SingleStatViewProperties.yml
@@ -10,7 +10,6 @@
     - tickPrefix
     - suffix
     - tickSuffix
-    - legend
     - decimalPlaces
   properties:
     type:
@@ -41,6 +40,8 @@
       type: string
     tickSuffix:
       type: string
+    staticLegend:
+      $ref: "./StaticLegend.yml"
     legend:
       $ref: "./Legend.yml"
     decimalPlaces:

diff --git a/src/common/schemas/StaticLegend.yml b/src/common/schemas/StaticLegend.yml
@@ -0,0 +1,18 @@
+  description: StaticLegend represents the options specific to the static legend
+  type: object
+  properties:
+    colorizeRows:
+      type: boolean
+    heightRatio:
+      type: number
+      format: float
+    opacity:
+      type: number
+      format: float
+    orientationThreshold:
+      type: integer
+    valueAxis:
+      type: string
+    widthRatio:
+      type: number
+      format: float
diff --git a/src/common/schemas/XYViewProperties.yml b/src/common/schemas/XYViewProperties.yml
@@ -6,7 +6,6 @@
     - shape
     - axes
     - colors
-    - legend
     - note
     - showNoteWhenEmpty
     - position
@@ -35,6 +34,8 @@
       type: boolean
     axes:
       $ref: "./Axes.yml"
+    staticLegend:
+      $ref: "./StaticLegend.yml"
     legend:
       $ref: "./Legend.yml"
     xColumn: