Datatable property settings¶
An overview of the possible keys than can be defined for an individual property in the Properties block of the data table settings.
- id
- Text (required). Identifier of the property, equal to the corresponding column header in the TAB-delimited source file
data
. - dataType
Text (required). Data type of the values in the property. Absent values can be coded by an empty string.. Possible values:
Text
: text strings.Float
: 32 bit floating point approximate number.Double
: 64 bit floating point approximate number.Boolean
: True/False binary states. Possible values 0,1,true,false.Int8
: 8 bit signed integer between -127 and 127.Int16
: 16 bit signed integer between -32767 and 32767.Int32
: 32 bit signed integer between -2147483647 and 2147483647.GeoLatitude
: latitude part of a geographical coordinates (in decimal degrees)..GeoLongitude
: longitude part of a geographical coordinates (in decimal degrees)..Date
: calendar dates, ISO formatted (i.e. YYYY-MM-DD)..
- name
- Text (required). Display name of the property.
- description
- Text. Brief description of the property. This will appear in hover tool tips and in the popup box if a user clicks a property info button.
- groupId
- Text. Id of the Property group this property belongs to.
- externalUrl
- Text. A url that should be opened when the user clicks on a value of this property. The url should
be formatted as a template, with
{value}
interpolated to the property value. For example:http://www.ebi.ac.uk/ena/data/view/{value}
. - isCategorical
- Boolean. Set automatically for columns with <50 distinct entries, unless set here. Instructs Panoptes to treat the property as a categorical variable. For example, a combo box with the possible states is automatically shown in queries for this property.
.
- valueColours
- Block. Specifies display colours for specific values of this property.
Each key in the block links a possible value of the property to a color (example:
Accepted: rgb(0,192,0)
). The special value_other_
can be used to specify a color for all other property values that are not listed explicitly. - valueDescriptions
- Block. Specifies descriptions for specific values of this property which will displayed next to it under an info icon..
- valueDisplays
- Block. Specifies display html for specific values of this property. The html will replace this value when it is displayed.
- defaultWidth
- Value. Sets the default column width in pixels..
- showBar
- Boolean. Draws a bar in the background of the table, indicating the value. Requires minVal & maxVal to be defined.(only applies if dataType is [‘Float’, ‘Double’, ‘Int8’, ‘Int16’, ‘Int32’, ‘Date’]).
- minVal
- Value. Set automatically from data unless overridden. For Value types, upper extent of scale(only applies if dataType is [‘Float’, ‘Double’, ‘Int8’, ‘Int16’, ‘Int32’, ‘Date’]).
- maxVal
- Value. Set automatically from data unless overridden. For Value types, lower extent of scale(only applies if dataType is [‘Float’, ‘Double’, ‘Int8’, ‘Int16’, ‘Int32’, ‘Date’]).
- decimDigits
- Value. For Value types, specifies the number of decimal digits used to display the value(only applies if dataType is [‘Float’, ‘Double’, ‘Int8’, ‘Int16’, ‘Int32’, ‘Date’]).
- index
- Boolean. Default:False. If set, instructs Panoptes to create an index for this property in the relational database. For large datasets, this massively speeds up queries and sort commands based on this property.
- search
Text. Default:None. Indicates that this field can be used for text search in the find data item wizard. Possible values:
None
: .Match
: only exact matched are searched for.StartPattern
: searches all text that starts with the string typed by the user.Pattern
: searches all text that contains the string typed by the user.
- relation
Block. Defines a many-to-one foreign relation to a parent data table. The parent table should contain a property with the same name as the primary key property in the child table. The block can contain the following keys:
- tableId
- DatatableID (required). Data table ID of the relation parent table.
- forwardName
- Text (required). Default:belongs to. Display name of the relation from child to parent.
- reverseName
- Text (required). Default:has. Display name of the relation from parent to child.
- showInTable
- Boolean. Default:True. If set to false this property will not be available to be shown in tables in the application.
- showInBrowser
- Boolean. Default:True. If set, this property will automatically appear as a track in the genome browser (only applies if IsPositionOnGenome is specified in database settings).
- tableDefaultVisible
- Boolean. Default:True. If set to true (default) then this property will appear in tables when they are first shown.
- browserDefaultVisible
- Boolean. Indicates that the track will activated by default in the genome browser (only applies if showInBrowser is True).
- browserShowOnTop
- Boolean. Indicates that the track will be shown in the top (non-scrolling) area of the genome browser. In this case, it will always be visible (only applies if showInBrowser is True).
- colour
- Text. Colour used to display this property. Formatted as
"rgb(r,g,b)"
or"#HHHHHH"
. - defaultVisible
- Boolean. Default:True. .