Skip to content

Commit

Permalink
updated docs prop
Browse files Browse the repository at this point in the history
  • Loading branch information
kwongz committed Oct 3, 2024
1 parent f668dde commit 888cd48
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 48 deletions.
10 changes: 1 addition & 9 deletions sites/docs/pages/components/area-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ Maximum value to use for the color scale.

<PropListing
name="legendType"
options={['category', 'scalar']}
options={['categorical', 'scalar']}
>
Appends a categorical or scalar legend to the map
</PropListing>
Expand All @@ -512,14 +512,6 @@ defaultValue='bottomLeft'
Determines the legend's position on the map, with options provided
</PropListing>

<PropListing
name="legendTitle"
options=string
defaultValue='Legend'
>
Specifies the title for the legend
</PropListing>

### Interactivity

<PropListing
Expand Down
14 changes: 1 addition & 13 deletions sites/docs/pages/components/bubble-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,6 @@ FROM la_locations
<BubbleMap
legendType="categorical"
legendPosition=bottomLeft
legendTitle=Legend
data={grouped_locations}
lat=lat
long=long
Expand All @@ -318,7 +317,6 @@ FROM la_locations
<BubbleMap
legendType="categorical"
legendPosition=bottomLeft
legendTitle=Legend
data={grouped_locations}
lat=lat
long=long
Expand All @@ -338,7 +336,6 @@ FROM la_locations
<BubbleMap
legendType=scalar
legendPosition=bottomLeft
legendTitle="Scalar Legend"
data={grouped_locations}
lat=lat
long=long
Expand All @@ -356,7 +353,6 @@ FROM la_locations
<BubbleMap
legendType=scalar
legendPosition=bottomLeft
legendTitle="Scalar Legend"
data={grouped_locations}
lat=lat
long=long
Expand Down Expand Up @@ -471,7 +467,7 @@ Maximum value to use for the color scale.

<PropListing
name="legendType"
options={['category', 'scalar']}
options={['categorical', 'scalar']}
>
Appends a categorical or scalar legend to the map
</PropListing>
Expand All @@ -484,14 +480,6 @@ defaultValue='bottomLeft'
Determines the legend's position on the map, with options provided
</PropListing>

<PropListing
name="legendTitle"
options=string
defaultValue='Legend'
>
Specifies the title for the legend
</PropListing>

### Interactivity

<PropListing
Expand Down
41 changes: 15 additions & 26 deletions sites/docs/pages/components/point-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,6 @@ FROM la_locations
<PointMap
legendType=categorical
legendPosition=bottomLeft
legendTitle=Legend
data={grouped_locations}
lat=lat
long=long
Expand All @@ -269,29 +268,27 @@ FROM la_locations
/>

```svelte
<PointMap
legendType=categorical
legendPosition=bottomLeft
legendTitle=Legend
data={grouped_locations}
lat=lat
long=long
value=Category
colorPalette={['#C65D47', '#5BAF7A', '#4A8EBA', '#D35B85', '#E1C16D', '#6F5B9A', '#4E8D8D']}
tooltipType=hover
tooltip={[
{ id: 'point_name', showColumnName: false, valueClass: 'text-lg font-semibold' },
{ id: 'sales', fmt: 'usd', fieldClass: 'text-[grey]', valueClass: 'text-[green]' }
]}
/>
<PointMap
legendType=categorical
legendPosition=bottomLeft
data={grouped_locations}
lat=lat
long=long
value=Category
colorPalette={['#C65D47', '#5BAF7A', '#4A8EBA', '#D35B85', '#E1C16D', '#6F5B9A', '#4E8D8D']}
tooltipType=hover
tooltip={[
{ id: 'point_name', showColumnName: false, valueClass: 'text-lg font-semibold' },
{ id: 'sales', fmt: 'usd', fieldClass: 'text-[grey]', valueClass: 'text-[green]' }
]}
/>
```

#### Scalar Legend

<PointMap
legendType=scalar
legendPosition=bottomLeft
legendTitle="Scalar Legend"
data={grouped_locations}
lat=lat
long=long
Expand All @@ -308,7 +305,6 @@ FROM la_locations
<PointMap
legendType=scalar
legendPosition=bottomLeft
legendTitle="Scalar Legend"
data={grouped_locations}
lat=lat
long=long
Expand Down Expand Up @@ -382,7 +378,7 @@ Maximum value to use for the color scale.

<PropListing
name="legendType"
options={['category', 'scalar']}
options={['categorical', 'scalar']}
>
Appends a categorical or scalar legend to the map
</PropListing>
Expand All @@ -395,13 +391,6 @@ defaultValue='bottomLeft'
Determines the legend's position on the map, with options provided
</PropListing>

<PropListing
name="legendTitle"
options=string
defaultValue='Legend'
>
Specifies the title for the legend
</PropListing>
### Interactivity

<PropListing
Expand Down

0 comments on commit 888cd48

Please sign in to comment.