You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This issue is meant to be an incremental change that gets our functionality closer to what is described in issue #156.
For now, only 1 selector will be allowed to be added. This selector will be displayed as a dropdown with the data coming from an ermrest request or hard coded as part of the selector.
Configuration
plots:[{
plotly: {
layout: {...},
config: {...}
},
config: {...},
dropdown: {
uid*: string - key for referencing the dropdown in other configuration properties,
label*: string - name to display next to the dropdown,
url_param_key?: string - parameter name from url params that is associated with the dropdown,
request_info: {
url_pattern?: string - string that allows for handlebars templating for fetching data,
data?: array of objects - values to use in the dropdown if no url_pattern is provided,
default_value?: string - the initial value to use on page load (url_param_key can be set to override this),
value_key*: string - column to use for templating in queries,
selected_value_pattern?: string - a pattern string to show in the dropdown for each selected option
tick_markdown_pattern*: string - a markdown pattern to be used for the axis labels
}
},
traces: [{...}]
}, ...]
Notes:
url_param_key can be defined to allow for a url parameter to be used to initialize the dropdown and fetch data using the url param value
1 of url_pattern or data has to be defined for this dropdown to have data in it
show configuration warning alert and show the dropdown as empty
still try to fetch data as if no option was selected and let the rest of the code handle any errors that occur
this property is used to fetch the value from the url and store it in $control_values.<dropdown.uid>.values.<dropdown.value_key>
default_valueshould be set if fetching data for the plot relies on a value being selected
needs to be a valid value for value_key in each row that is returned from url_pattern or data
selected_value_pattern is optional. If not defined, use rowname (if url_pattern) or the value_key
This property will be accessed in templating user the $control_values namespace
this replaces $url_parameters that was introduced with violin plot
support both, mark url_parameters as deprecated
the selected data will be made available in templating
This example uses the gene selector data to initialize a single dropdown for violin plot assuming we will always use "all studies" and not allow study selection to be changed
This issue is meant to be an incremental change that gets our functionality closer to what is described in issue #156.
For now, only 1 selector will be allowed to be added. This selector will be displayed as a dropdown with the data coming from an ermrest request or hard coded as part of the selector.
Configuration
Notes:
url_param_key
can be defined to allow for a url parameter to be used to initialize the dropdown and fetch data using the url param valueurl_pattern
ordata
has to be defined for this dropdown to have data in it$control_values.<dropdown.uid>.values.<dropdown.value_key>
default_value
should be set if fetching data for the plot relies on a value being selectedvalue_key
in each row that is returned fromurl_pattern
ordata
selected_value_pattern
is optional. If not defined, use rowname (if url_pattern) or thevalue_key
$control_values
namespace$url_parameters
that was introduced with violin ploturl_parameters
as deprecated$control_values.<dropdown.uid>.values.<dropdown.value_key>
Example with "data"
This example is for changing the consortium value that is present in the url_pattern.
Example with "url_pattern"
This example uses the gene selector data to initialize a single dropdown for violin plot assuming we will always use "all studies" and not allow study selection to be changed
The text was updated successfully, but these errors were encountered: