JSDoc: Global

Methods

$_GET(param)

Allows you to get information from the url of the page

Parameters:

Name	Type	Description
`param`	string	The tag you want to check.

Source:

utilities.js, line 46

abortExport()

Abort the export of datamatrix

Source:

utilities.js, line 119

abortGermplasmsExport()

Abort the export of Germplasms Details tsv

Source:

utilities.js, line 127

addGrp(caller)

Add another url group

Parameters:

Name	Type	Description
`caller`	String	The Caller of the function

Source:

view/grpWidgetView.js, line 71

addGrp2(caller)

Add another url to caller's Group without any url inside

Parameters:

Name	Type	Description
`caller`	String	The Caller of the function

Source:

view/grpWidgetView.js, line 101

addUrl(caller)

Add another url to caller's Group

Parameters:

Name	Type	Description
`caller`	String	The Caller of the function

Source:

view/grpWidgetView.js, line 6

addUrl2(caller, caller)

Add another url with preset value to caller's Group

Parameters:

Name	Type	Description
`caller`	String	The Caller of the function
`caller`	Urlwithauth	The urlwithauth used for get the preset value

Source:

view/grpWidgetView.js, line 29

(async) allelematrix(argumentsArray)

Function responsible for exporting the matrix

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 259

animatForm()

Animate html page

Source:

view/view.js, line 205

array_big_intersect()

Return intersection of 2 array

Source:

utilities.js, line 154

bindCall2Url(resp, calls)

Generate call to url hmap

Parameters:

Name	Type	Description
`resp`	Array	result of getCall function
`calls`	Array	Url tab

Source:

hmap.js, line 44

buildTsvString(HMap, selectedGermplasms, fieldTab)

Generate Tsv String

Parameters:

Name	Type	Description
`HMap`	Array	Json-Hmap
`selectedGermplasms`	Array	The selected Germplasms
`fieldTab`	Array	Fields of the futur file

Source:

export.js, line 110

callsAreInArray(resp, requCall)

True if requ calls are in the resp array

Parameters:

Name	Type	Description
`resp`	array	reponse of GetCall function
`requCall`	array	Array of requ call

Source:

calls.js, line 37

cleanTab(sendedMarkers, sendedMarkersProlis)

Remove missing data from result tab

Parameters:

Name	Type	Description
`sendedMarkers`	Array	Matrix marker list
`sendedMarkersProlis`	Array	Matrix marker-profil list

Source:

view/tabView.js, line 27

enmptResultTab()

Set result table empty

Source:

view/tabView.js, line 59

(async) ExportDetailsGermplasms()

Launch export of allelematrix

Source:

export.js, line 28

(async) exportMatrix()

Launch export of allelematrix

Source:

export.js, line 6

fill_result_table(sendedMarkers, sendedMarkersProlis, response)

fill result table

Parameters:

Name	Type	Description
`sendedMarkers`	Array	Matrix marker list
`sendedMarkersProlis`	Array	Matrix marker-profil list
`response`	Array	The response to getMatrix function

Source:

view/tabView.js, line 8

fillWidget(array)

Fill the widget with the group tab generated from the client url

Parameters:

Name	Type	Description
`array`	Array	the current GroupTab

Source:

view/grpWidgetView.js, line 130

Germplasms(filename, tsvData-)

Generate Tsv String

Parameters:

Name	Type	Description
`filename`	Strint	Name of the futur file
`tsvData-`	String	The string to encoded in the tsv file

Source:

export.js, line 154

(async) getCalls(urlWithToken)

Get the liste of call implemented by the brapi endpoint you passed

Parameters:

Name	Type	Description
`urlWithToken`	urlWithAuth	The Url

Source:

getting_Information.js, line 68

getFieldFormJson(HMap)

Generate field Tab from Json-Hmap

Parameters:

Name	Type	Description
`HMap`	Array	Json-Hmap

Source:

export.js, line 82

(async) getGermplasmsDetails(argumentsArray)

Return the details for a given Germplasms

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 299

(async) getMapDetails(argumentsArray)

Return the details for a given map

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 178

(async) getmarkerProfileDbId(argumentsArray)

Return the list of Marker Profile for a given url

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 131

getMarkerProfileHmap(arrayGermplasms)

Generate germplasmDbId to germplasm Hmap

Parameters:

Name	Type	Description
`arrayGermplasms`	Array	Array of germplasm

Source:

hmap.js, line 6

(async) getMarkers(argumentsArray)

Return the list of Marker for a given url

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 151

(async) getMarkersPosition(argumentsArray)

Return the list of Marker Position for a given url

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 197

(async) getMatrix(argumentsArray)

Return the data matrix for a given marker list/ marker profile list

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 218

(async) getToken(stringUserName, stringPassword, urlEndPoint)

Get a Token.

Parameters:

Name	Type	Description
`stringUserName`	string	The User Name.
`stringPassword`	string	The Password.
`urlEndPoint`	string	The brapi endpoint.

Source:

getting_Information.js, line 9

getTypeList(arrayMarker)

Get type list from a marker tab

Parameters:

Name	Type	Description
`arrayMarker`	array	Marker table

Source:

utilities.js, line 136

(async) handleErrors(err)

Handle Errors

Parameters:

Name	Type	Description
`err`	Error	current error

Source:

view/view.js, line 173

insetMatrixInResultTable(sendedMarkers, sendedMarkersProlis, response)

insert matrix in result table

Parameters:

Name	Type	Description
`sendedMarkers`	Array	Matrix marker list
`sendedMarkersProlis`	Array	Matrix marker-profil list
`response`	Array	The response to getMatrix function

Source:

view/tabView.js, line 46

isInArray(array, value)

Return true if value is present in the table, wrong if not

Parameters:

Name	Type	Description
`array`	array	The array you want to scan.
`value`	string	The value you search .

Source:

utilities.js, line 7

nextPage()

Advance one page in the matrix

Source:

pagination.js, line 5

prevPage()

Moves one page backwards in the matrix

Source:

pagination.js, line 19

(async) readMaps(argumentsArray)

Return the list of maps for a given url

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 89

(async) readStudyList(argumentsArray)

Return the list of studies for a given url

Parameters:

Name	Type	Description
`argumentsArray`	array	Array containing the parameters required by the function

Source:

getting_Information.js, line 110

removeAll(array, value)

Remove all occurrence of a value from an array

Parameters:

Name	Type	Description
`array`	array	The array you want to scan.
`value`	string	The value you want to remove .

Source:

utilities.js, line 66

(async) requCallareImplement()

Removes url group that do not implement the required calls

Source:

calls.js, line 6

returnInit(token)

Returns the standard header

Parameters:

Name	Type	Description
`token`	strint	A token.

Source:

utilities.js, line 30

reversHmap(hMap-)

Revers any hmap;

Parameters:

Name	Type	Description
`hMap-`	Array	The current Hmap.

Source:

hmap.js, line 28

(async) rmThisGrp(caller)

Remove the url group of the caller

Parameters:

Name	Type	Description
`caller`	String	The Caller of the function

Source:

view/grpWidgetView.js, line 118

(async) rmUrl(caller)

Remove last url of caller's Group

Parameters:

Name	Type	Description
`caller`	String	The Caller of the function

Source:

view/grpWidgetView.js, line 52

selectStudies()

Set htmp of studies widget

Source:

view/view.js, line 23

setArgumentArray(callName, argumentsArray)

Set up the argumentArray for the call you want to call

Parameters:

Name	Type	Description
`callName`	string	The call you want to call
`argumentsArray`	Array	Array containing the parameters required by the function

Source:

utilities.js, line 96

setCustomIndex()

Set the index too another value

Source:

pagination.js, line 46

setCustomPageSize()

Set the page size too another value

Source:

pagination.js, line 33

setDisabled(bool)

Set html object disabled or undisabled

Parameters:

Name	Type	Description
`bool`	Boolean	true or false

Source:

view/view.js, line 192

setEmptyMarkerSelect()

Set Empty Marker field

Source:

view/view.js, line 59

setEmptyTheFields()

Set empty all fields

Source:

view/view.js, line 39

setHmapLinkageGroup(arrayOfLinkageGroup, arrayMarkers)

Generate LinkageGroup to Marker Hmap

Parameters:

Name	Type	Description
`arrayOfLinkageGroup`	Array	All LinkageGroup
`arrayMarkers`	Array	All Markers

Source:

hmap.js, line 70

setHmapType(arrayOfMarkersType, arrayMarkers)

Generate Type to Marker Hmap

Parameters:

Name	Type	Description
`arrayOfMarkersType`	Array	All Marker Type
`arrayMarkers`	Array	All Markers

Source:

hmap.js, line 88

setup_select_tag(firstinformations)

insert matrix in result table

Parameters:

Name	Type	Description
`firstinformations`	Array	array containing the maps and studies that were found

Source:

view/view.js, line 6

setUpGermplasms(response)

Set up html of Germplasms widget

Parameters:

Name	Type	Description
`response`	Array	array of marker profile

Source:

view/view.js, line 68

setUpLinkageGroupAndMarkersType(arrayOfLinkageGroup, arrayOfMarkersType)

Set up Html of LinkageGroup and MarkersType widget

Parameters:

Name	Type	Description
`arrayOfLinkageGroup`	Array	array Of LinkageGroup
`arrayOfMarkersType`	Array	array Of MarkersType

Source:

view/view.js, line 109

setUpMarkerProfils()

Set up html of Markers Profils widget

Source:

view/view.js, line 85

setupMarkersId(arrayMarkersIds)

Set up Html of Marker widget

Parameters:

Name	Type	Description
`arrayMarkersIds`	Array	array of MarkersIds

Source:

view/view.js, line 129

sleep(ms)

Stop the program for a given period of time

Parameters:

Name	Type	Description
`ms`	int	The number of ms you want to wait befor the resolution of the promise .

Source:

utilities.js, line 21

updateSelection(idLabel, idSelect)

update the label of the current select

Parameters:

Name	Type	Description
`idLabel`	Array	selected label
`idSelect`	Array	selected select

Source:

view/view.js, line 157

(async) urlBrapiEndPointIsOk(brapiEndPoint)

Check the brapiEndPoint coming from the url.

Parameters:

Name	Type	Description
`brapiEndPoint`	string	The brapi endpoint.

Source:

getting_Information.js, line 48

(async) urlMapIdIsOk(brapiEndPoint, mapDbId)

Check the map coming from the url.

Parameters:

Name	Type	Description
`brapiEndPoint`	string	The brapi endpoint.
`mapDbId`	string	The Password.

Source:

getting_Information.js, line 32