Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 32 additions & 21 deletions frontend/src/components/CrossSearch/CrossSearchTable.tsx
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
import { lazy, Suspense, useMemo } from 'react'
import { type MRT_ColumnDef, type MRT_RowData, type MRT_TableInstance } from 'material-react-table'
import { CrossSearch, formatDevelopmentalCrownType } from '@/shared/types'
import { TableView } from '../TableView/TableView'
import type { ColumnVisibilityGroup } from '../TableView/TableToolBar'
import { useGetAllCrossSearchQuery, useGetAllCrossSearchLocalitiesQuery } from '@/redux/crossSearchReducer'
import { usePageContext } from '../Page'
import { formatWithMaxThreeDecimals } from '@/util/numberFormatting'
import { occurrenceLabels } from '@/constants/occurrenceLabels'
import { OccurrenceDwcExportMenuItem } from '@/components/Occurrence/OccurrenceDwcExportMenuItem'
import { OccurrenceDwcDpExportMenuItem } from '@/components/Occurrence/OccurrenceDwcDpExportMenuItem'
import { OccurrenceDwcExportMenuItem } from '@/components/Occurrence/OccurrenceDwcExportMenuItem'
import { OccurrenceFullDarwinCoreExportMenuItem } from '@/components/Occurrence/OccurrenceFullDarwinCoreExportMenuItem'
import { matchesCountryOrContinent } from '@/shared/validators/countryContinents'
import {
exportOccurrenceMapKml,
exportOccurrenceMapSvg,
getUniqueCrossSearchMapExportLocalities,
MapExportLocality,
toMapExportLocality,
} from '@/components/Species/localitySpeciesMapExport'
import { occurrenceLabels } from '@/constants/occurrenceLabels'
import { useGetAllCrossSearchLocalitiesQuery, useGetAllCrossSearchQuery } from '@/redux/crossSearchReducer'
import { CrossSearch, formatDevelopmentalCrownType } from '@/shared/types'
import { matchesCountryOrContinent } from '@/shared/validators/countryContinents'
import { formatWithMaxThreeDecimals } from '@/util/numberFormatting'
import { CircularProgress } from '@mui/material'
import { type MRT_ColumnDef } from 'material-react-table'
import { lazy, Suspense, useMemo } from 'react'
import { usePageContext } from '../Page'
import type { ColumnVisibilityGroup } from '../TableView/TableToolBar'
import { TableView } from '../TableView/TableView'
import { useNotify } from '@/hooks/notification'

const LocalitiesMap = lazy(async () => {
const module = await import('../Map/LocalitiesMap')
Expand All @@ -40,6 +43,7 @@ export const CrossSearchTable = ({ selectorFn }: { selectorFn?: (newObject: Cros
columnFilters: sqlColumnFilters,
sorting: sqlOrderBy,
})
const { notify } = useNotify()

// Show/Hide columns in the following order
const columns = useMemo<MRT_ColumnDef<CrossSearch>[]>(
Expand Down Expand Up @@ -1078,21 +1082,28 @@ export const CrossSearchTable = ({ selectorFn }: { selectorFn?: (newObject: Cros
[]
)

if (!localitiesData) return <CircularProgress />

const checkRowRestriction = (row: CrossSearch) => {
return !!row.loc_status
}

const getExportLocalities = <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
const rows = table.getPrePaginationRowModel().rows.map(row => row.original as unknown as CrossSearch)
return getUniqueCrossSearchMapExportLocalities(rows)
}

const kmlExport = <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
exportOccurrenceMapKml(table, 'occurrences', getExportLocalities)
const kmlExport = () => {
const exportedLocalities = localitiesData.map(loc => toMapExportLocality(loc))
if (exportedLocalities.filter(loc => loc === null).length > 0) {
notify('Some localities failed to export, aborting.', 'error', 5)
return
}
exportOccurrenceMapKml('occurrences', exportedLocalities as MapExportLocality[])
}

const svgExport = async <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
await exportOccurrenceMapSvg(table, 'occurrences-map', getExportLocalities)
const svgExport = async () => {
const exportedLocalities = localitiesData.map(loc => toMapExportLocality(loc))
if (exportedLocalities.filter(loc => loc === null).length > 0) {
notify('Some localities failed to export, aborting.', 'error', 5)
return
}
await exportOccurrenceMapSvg('occurrences-map', exportedLocalities as MapExportLocality[])
}

return (
Expand Down
28 changes: 17 additions & 11 deletions frontend/src/components/Locality/Tabs/OccurrencesTab.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { OccurrenceWearTab } from '@/components/Occurrence/Tabs/OccurrenceWearTa
import {
exportOccurrenceMapKml,
exportOccurrenceMapSvg,
getUniqueLocalityOccurrenceMapExportLocalities,
toMapExportLocality,
} from '@/components/Species/localitySpeciesMapExport'
import { occurrenceLabels } from '@/constants/occurrenceLabels'
import { useNotify } from '@/hooks/notification'
Expand All @@ -44,7 +44,7 @@ import { ValidationObject } from '@/shared/validators/validator'
import ManageSearchIcon from '@mui/icons-material/ManageSearch'
import SaveIcon from '@mui/icons-material/Save'
import { Box, Button, DialogActions, DialogContent, Tooltip } from '@mui/material'
import type { MRT_ColumnDef, MRT_Row, MRT_RowData, MRT_TableInstance } from 'material-react-table'
import type { MRT_ColumnDef, MRT_Row } from 'material-react-table'
import { useMemo, useState } from 'react'
import { Link, useLocation } from 'react-router-dom'

Expand Down Expand Up @@ -184,6 +184,7 @@ export const OccurrencesTab = () => {
const { mode, data, editData, setEditData } = useDetailContext<LocalityDetailsType>()
const [fieldsWithErrors, setFieldsWithErrors] = useState<FieldsWithErrorsType>({})
const location = useLocation()
const { notify } = useNotify()

const sortedOccurrenceRows = useMemo(() => {
const sourceRows = (mode.read ? data.now_ls : editData.now_ls) as unknown as Editable<LocalitySpecies>[]
Expand Down Expand Up @@ -369,17 +370,22 @@ export const OccurrencesTab = () => {
},
]

const getExportLocalities = <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
const rows = table.getPrePaginationRowModel().rows.map(row => row.original as unknown as LocalitySpecies)
return getUniqueLocalityOccurrenceMapExportLocalities(data, rows)
}

const kmlExport = <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
exportOccurrenceMapKml(table, 'locality-occurrences', getExportLocalities)
const kmlExport = () => {
const exportedLocality = toMapExportLocality(editData)
if (!exportedLocality) {
notify('Failed to export locality.', 'error', 5)
return
}
exportOccurrenceMapKml('locality-species', [exportedLocality])
}

const svgExport = async <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
await exportOccurrenceMapSvg(table, 'locality-occurrences-map', getExportLocalities)
const svgExport = async () => {
const exportedLocality = toMapExportLocality(editData)
if (!exportedLocality) {
notify('Failed to export locality.', 'error', 5)
return
}
await exportOccurrenceMapSvg('locality-species-map', [exportedLocality])
}

const textField = (field: keyof EditDataType<OccurrenceDetailsType>, options?: TextFieldOptions) => (
Expand Down
10 changes: 5 additions & 5 deletions frontend/src/components/Map/generateSvg.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { SVG } from '@svgdotjs/svg.js'
import { countryPolygons } from '../../country_data/countryPolygons.ts'
import { Locality } from '@/shared/types'
import { MapExportLocality } from '../Species/localitySpeciesMapExport.ts'

interface PixelCoordinates {
x: number
Expand All @@ -22,7 +22,7 @@ const webMercatorConvert = (lat: number, long: number, width: number): PixelCoor

// Generates and returns an SVG image of localities on a map.
export const generateSvg = (
localities: Locality[],
localities: MapExportLocality[],
mapBorderColor = '#000000',
mapFillColor = '#ffffff',
markerBorderColor = '#ff0000',
Expand All @@ -48,9 +48,9 @@ export const generateSvg = (
draw.polygon(polygon).stroke({ width: 1, color: mapBorderColor }).fill(mapFillColor)
})

localities.forEach(locality => {
const pixelCoords = webMercatorConvert(locality.dec_lat, locality.dec_long, width)
const radius = 3
localities.forEach(loc => {
const pixelCoords = webMercatorConvert(loc.dec_lat, loc.dec_long, width)
const radius = 10
const topLeftX = pixelCoords.x - radius
const topLeftY = pixelCoords.y - radius
draw.circle(radius).move(topLeftX, topLeftY).stroke({ width: 1, color: markerBorderColor }).fill(markerFillColor)
Expand Down
44 changes: 26 additions & 18 deletions frontend/src/components/Species/Tabs/LocalitySpeciesTab.tsx
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
import { Editable, SpeciesDetailsType, SpeciesLocality } from '@/shared/types'
import { applyDefaultSpeciesOrdering, hasActiveSortingInSearch } from '@/components/DetailView/common/DetailTabTable'
import { EditableTable } from '@/components/DetailView/common/EditableTable'
import { EditingModal } from '@/components/DetailView/common/EditingModal'
import { EntryUpdateHistory } from '@/components/DetailView/common/FieldUpdateHistory'
import { Grouped } from '@/components/DetailView/common/tabLayoutHelpers'
import { useDetailContext } from '@/components/DetailView/Context/DetailContext'
import { Box, TextField } from '@mui/material'
import { MRT_ColumnDef, MRT_Row, MRT_RowData, MRT_TableInstance } from 'material-react-table'
import { occurrenceLabels } from '@/constants/occurrenceLabels'
import { Editable, SpeciesDetailsType, SpeciesLocality } from '@/shared/types'
import { calculateNormalizedMesowearScore } from '@/shared/utils/mesowear'
import { matchesCountryOrContinent } from '@/shared/validators/countryContinents'
import { Box, TextField } from '@mui/material'
import { MRT_ColumnDef, MRT_Row } from 'material-react-table'
import { useMemo } from 'react'
import { useForm } from 'react-hook-form'
import { calculateNormalizedMesowearScore } from '@/shared/utils/mesowear'
import { applyDefaultSpeciesOrdering, hasActiveSortingInSearch } from '@/components/DetailView/common/DetailTabTable'
import { useLocation } from 'react-router-dom'
import { useMemo } from 'react'
import { occurrenceLabels } from '@/constants/occurrenceLabels'
import {
exportOccurrenceMapKml,
exportOccurrenceMapSvg,
getUniqueSpeciesLocalityMapExportLocalities,
MapExportLocality,
toMapExportLocality,
} from '../localitySpeciesMapExport'
import { EntryUpdateHistory } from '@/components/DetailView/common/FieldUpdateHistory'
import { useNotify } from '@/hooks/notification'

const hasMesowearScoreInputs = (row: SpeciesLocality) => {
return (
Expand All @@ -37,6 +39,7 @@ export const LocalitySpeciesTab = () => {
register,
formState: { errors },
} = useForm()
const { notify } = useNotify()

const sortedLocalitySpeciesRows = useMemo(() => {
const sourceRows = (mode.read ? data.now_ls : editData.now_ls) as unknown as Editable<SpeciesLocality>[]
Expand Down Expand Up @@ -203,17 +206,22 @@ export const LocalitySpeciesTab = () => {
return Object.keys(errors).length === 0
}

const getExportLocalities = <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
const rows = table.getPrePaginationRowModel().rows.map(row => row.original as unknown as SpeciesLocality)
return getUniqueSpeciesLocalityMapExportLocalities(data, rows)
}

const kmlExport = <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
exportOccurrenceMapKml(table, 'locality-species', getExportLocalities)
const kmlExport = () => {
const exportedLocalities = data.now_ls.map(loc => toMapExportLocality(loc))
if (exportedLocalities.filter(loc => loc === null).length > 0) {
notify('Some localities failed to export, aborting.', 'error', 5)
return
}
exportOccurrenceMapKml('locality-species', exportedLocalities as MapExportLocality[])
}

const svgExport = async <T extends MRT_RowData>(table: MRT_TableInstance<T>) => {
await exportOccurrenceMapSvg(table, 'locality-species-map', getExportLocalities)
const svgExport = async () => {
const exportedLocalities = data.now_ls.map(loc => toMapExportLocality(loc))
if (exportedLocalities.filter(loc => loc === null).length > 0) {
notify('Some localities failed to export, aborting.', 'error', 5)
return
}
await exportOccurrenceMapSvg('locality-species-map', exportedLocalities as MapExportLocality[])
}

const editingModal = (
Expand Down
21 changes: 7 additions & 14 deletions frontend/src/components/Species/localitySpeciesMapExport.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { currentDateAsString } from '@/shared/currentDateAsString'
import type { CrossSearch, Locality, LocalityDetailsType, LocalitySpecies, SpeciesLocality } from '@/shared/types'
import { generateKml } from '@/util/kml'
import { currentDateAsString } from '@/shared/currentDateAsString'
import type { MRT_RowData, MRT_TableInstance } from 'material-react-table'

type SpeciesSource = {
species_id?: number | null
Expand Down Expand Up @@ -167,21 +166,15 @@ const downloadTextFile = (dataString: string, type: string, filename: string) =>
a.href = url
a.download = filename
a.click()
a.remove()
URL.revokeObjectURL(url)
}

export const exportOccurrenceMapKml = <T extends MRT_RowData>(
table: MRT_TableInstance<T>,
filenamePrefix: string,
getLocalities: (table: MRT_TableInstance<T>) => MapExportLocality[]
) => {
downloadTextFile(generateKml(getLocalities(table)), 'text/kml', `${filenamePrefix}-${currentDateAsString()}.kml`)
export const exportOccurrenceMapKml = (filenamePrefix: string, localities: MapExportLocality[]) => {
downloadTextFile(generateKml(localities), 'text/kml', `${filenamePrefix}-${currentDateAsString()}.kml`)
}

export const exportOccurrenceMapSvg = async <T extends MRT_RowData>(
table: MRT_TableInstance<T>,
filenamePrefix: string,
getLocalities: (table: MRT_TableInstance<T>) => MapExportLocality[]
) => {
export const exportOccurrenceMapSvg = async (filenamePrefix: string, localities: MapExportLocality[]) => {
const { generateSvg } = await import('@/components/Map/generateSvg')
downloadTextFile(generateSvg(getLocalities(table)), 'image/svg+xml', `${filenamePrefix}-${currentDateAsString()}.svg`)
downloadTextFile(generateSvg(localities), 'image/svg+xml', `${filenamePrefix}-${currentDateAsString()}.svg`)
}
2 changes: 0 additions & 2 deletions frontend/src/components/TableView/TableToolBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,6 @@ export const TableToolBar = <T extends MRT_RowData>({

const runMapExport = async (label: string, exportFn: (table: MRT_TableInstance<T>) => void | Promise<void>) => {
notify(`Preparing ${label} export...`, 'info', null)
const rowCount = table.getPrePaginationRowModel().rows.length
setNotificationMessage(`Generating ${label} export from ${rowCount} rows...`)
await exportFn(table)
setNotificationMessage(`Saving ${label} export...`)
notify('Download finished.')
Expand Down
23 changes: 16 additions & 7 deletions frontend/src/tests/components/LocalitySpeciesTab.test.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import type { ReactNode } from 'react'
import { beforeEach, describe, expect, it, jest } from '@jest/globals'
import { render } from '@testing-library/react'
import { LocalitySpeciesTab } from '@/components/Species/Tabs/LocalitySpeciesTab'
import { modeOptionToMode, useDetailContext } from '@/components/DetailView/Context/DetailContext'
import { NotificationContextProvider } from '@/components/Notification'
import { LocalitySpeciesTab } from '@/components/Species/Tabs/LocalitySpeciesTab'
import { occurrenceLabels } from '@/constants/occurrenceLabels'
import type { SpeciesLocality } from '@/shared/types'
import { beforeEach, describe, expect, it, jest } from '@jest/globals'
import { render } from '@testing-library/react'
import type { MRT_ColumnDef, MRT_Row } from 'material-react-table'
import { occurrenceLabels } from '@/constants/occurrenceLabels'
import type { ReactNode } from 'react'

jest.mock('react-router-dom', () => {
const actual = jest.requireActual<typeof import('react-router-dom')>('react-router-dom')
Expand Down Expand Up @@ -75,7 +76,11 @@ describe('LocalitySpeciesTab MW score prerequisites', () => {
})

it('passes MW scale/value columns and MW Score cell can read values from row data', () => {
render(<LocalitySpeciesTab />)
render(
<NotificationContextProvider>
<LocalitySpeciesTab />
</NotificationContextProvider>
)

const firstCall = editableTableMock.mock.calls[0]
expect(firstCall).toBeDefined()
Expand Down Expand Up @@ -116,7 +121,11 @@ describe('LocalitySpeciesTab MW score prerequisites', () => {
mode: modeOptionToMode.edit,
} as never)

render(<LocalitySpeciesTab />)
render(
<NotificationContextProvider>
<LocalitySpeciesTab />
</NotificationContextProvider>
)

const grouped = document.querySelector('[data-testid="grouped"]')

Expand Down
3 changes: 2 additions & 1 deletion frontend/src/util/kml.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { MapExportLocality } from '@/components/Species/localitySpeciesMapExport'
import { Locality } from '@/shared/types'

type KmlLocality = Locality & {
Expand Down Expand Up @@ -78,7 +79,7 @@ const generatePlacemarkKml = (locality: KmlLocality) => {
}

// Returns an XML / KML string containing locality information as map markers, openable in Google Earth for example.
export const generateKml = (localities: KmlLocality[]) => {
export const generateKml = (localities: MapExportLocality[]) => {
let kmlString = `<?xml version="1.0" encoding="UTF-8"?>\n`
kmlString +=
`<kml xmlns="http://www.opengis.net/kml/2.2" xmlns:gx="http://www.google.com/kml/ext/2.2" ` +
Expand Down
Loading