@undp/data-viz 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -4702,7 +4702,7 @@ declare interface Props_10 {
4702
4702
  strokeWidth?: number;
4703
4703
  /** Toggle the initial animation of the line. If the type is number then it uses the number as the time in seconds for animation. */
4704
4704
  animate?: boolean | AnimateDataType;
4705
- /** Format of the date in the data object */
4705
+ /** Format of the date in the data object. Available formats can be found [here](https://date-fns.org/docs/format) */
4706
4706
  dateFormat?: string;
4707
4707
  /** Title for the Y-axis */
4708
4708
  yAxisTitle?: string;
@@ -4815,7 +4815,7 @@ declare interface Props_11 {
4815
4815
  animate?: boolean | AnimateDataType;
4816
4816
  /** Labels for the lines */
4817
4817
  labels: [string, string];
4818
- /** Format of the date in the data object */
4818
+ /** Format of the date in the data object. Available formats can be found [here](https://date-fns.org/docs/format) */
4819
4819
  dateFormat?: string;
4820
4820
  /** Title for the Y-axis */
4821
4821
  yAxisTitle?: string;
@@ -4890,7 +4890,7 @@ declare interface Props_12 {
4890
4890
  maxValue?: number;
4891
4891
  /** Minimum value for the chart */
4892
4892
  minValue?: number;
4893
- /** Format of the date in the data object */
4893
+ /** Format of the date in the data object. Available formats can be found [here](https://date-fns.org/docs/format) */
4894
4894
  dateFormat?: string;
4895
4895
  /** Toggles the visibility of the area below the line */
4896
4896
  area?: boolean;
@@ -5270,6 +5270,8 @@ declare interface Props_16 {
5270
5270
  showColorScale?: boolean;
5271
5271
  /** Property in the property object in mapData geoJson object is used to match to the id in the data object */
5272
5272
  mapProperty?: string;
5273
+ /** Countries or regions to be highlighted */
5274
+ highlightedIds?: string[];
5273
5275
  /** Enable data download option as a csv */
5274
5276
  dataDownload?: boolean;
5275
5277
  /** Reset selection on double-click. Only applicable when used in a dashboard context with filters. */
@@ -5922,7 +5924,7 @@ declare interface Props_23 {
5922
5924
  noOfXTicks?: number;
5923
5925
  /** No. of ticks on the y-axis */
5924
5926
  noOfYTicks?: number;
5925
- /** Format of the date in the data object */
5927
+ /** Format of the date in the data object. Available formats can be found [here](https://date-fns.org/docs/format) */
5926
5928
  dateFormat?: string;
5927
5929
  /** Toggle visibility of color scale. This is only applicable if the data props hae color parameter */
5928
5930
  showColorScale?: boolean;
@@ -7617,7 +7619,7 @@ declare interface Props_6 {
7617
7619
  showColorScale?: boolean;
7618
7620
  /** Labels for the lines */
7619
7621
  labels: [string, string];
7620
- /** Format of the date in the data object */
7622
+ /** Format of the date in the data object. Available formats can be found [here](https://date-fns.org/docs/format) */
7621
7623
  dateFormat?: string;
7622
7624
  /** Highlighted area(square) on the chart */
7623
7625
  highlightAreaSettings?: HighlightAreaSettingsDataType[];
@@ -7726,7 +7728,7 @@ declare interface Props_7 {
7726
7728
  intervalAreaOpacity?: number;
7727
7729
  /** Toggle the initial animation of the line. If the type is number then it uses the number as the time in seconds for animation. */
7728
7730
  animate?: boolean | AnimateDataType;
7729
- /** Format of the date in the data object */
7731
+ /** Format of the date in the data object. Available formats can be found [here](https://date-fns.org/docs/format) */
7730
7732
  dateFormat?: string;
7731
7733
  /** Title for the Y-axis */
7732
7734
  yAxisTitle?: string;
@@ -7825,7 +7827,7 @@ declare interface Props_8 {
7825
7827
  strokeWidth?: number;
7826
7828
  /** Toggle the initial animation of the line. If the type is number then it uses the number as the time in seconds for animation. */
7827
7829
  animate?: boolean | AnimateDataType;
7828
- /** Format of the date in the data object */
7830
+ /** Format of the date in the data object. Available formats can be found [here](https://date-fns.org/docs/format) */
7829
7831
  dateFormat?: string;
7830
7832
  /** Title for the Y-axis */
7831
7833
  yAxisTitle?: string;
@@ -7936,7 +7938,7 @@ declare interface Props_9 {
7936
7938
  strokeWidth?: number;
7937
7939
  /** Toggle the initial animation of the line. If the type is number then it uses the number as the time in seconds for animation. */
7938
7940
  animate?: boolean | AnimateDataType;
7939
- /** Format of the date in the data object */
7941
+ /** Format of the date in the data object. Available formats can be found [here](https://date-fns.org/docs/format) */
7940
7942
  dateFormat?: string;
7941
7943
  /** Title for the Y-axis */
7942
7944
  yAxisTitle?: string;