new TableStyle(optionsopt)
- Source:
A set of properties that define how a table, such as a CSV file, should be displayed. If not set explicitly, many of these properties will be given default or guessed values elsewhere, such as in CsvCatalogItem.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
The values of the properties of the new instance. Options may include all those options found in TableColumnStyle, plus: Properties
|
Extends
Members
active :Boolean
- Source:
- Inherited From:
Is this column active?
Type:
- Boolean
allVariablesUnactive :String
- Source:
Whether all variables have been unselected
Type:
- String
chartLineColor :String
- Source:
- Inherited From:
Color for column (css string)
Type:
- String
clampDisplayValue :Boolean
- Source:
- Inherited From:
Display values that fall outside the display range as min and max colors.
Type:
- Boolean
colorBinMethod :String
- Source:
- Inherited From:
The method for quantising colors:
- For numeric columns: "auto" (default), "ckmeans", "quantile" or "none" (equivalent to colorBins: 0).
- For enumerated columns: "auto" (default), "top", or "cycle"
Type:
- String
colorBins :Integer|Array.<Number>
- Source:
- Inherited From:
Either the number of discrete colours that a color gradient should be quantised into (ie. an integer), or an array of values specifying the boundaries between the color bins.
Type:
- Integer | Array.<Number>
columns :Object
- Source:
Column-specific styling, with the format { columnIdentifier1: tableColumnStyle1, columnIdentifier2: tableColumnStyle2, ... }, where columnIdentifier is either the name or the column index (zero-based).
Type:
- Object
dataVariable :String
- Source:
The name of the default variable (column) containing data to be used for scaling and coloring.
Type:
- String
displayDuration :Float
- Source:
- Inherited From:
Display duration for each row in the table, in minutes. If not provided, this is estimated from the data.
Type:
- Float
featureInfoFields :Object
- Source:
- Inherited From:
An object of { "myCol": "My column" } properties, defining which columns get displayed in feature info boxes (when clicked on), and what label is used instead of the column's actual name.
Type:
- Object
format :String|Number
- Source:
- Inherited From:
A format string for this column. For numbers, this is passed as options to toLocaleString. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString .
Type:
- String | Number
imageUrl :String
- Source:
- Inherited From:
A string representing an image to display at each point, for lat-long datasets.
Type:
- String
legendName :String
- Source:
- Inherited From:
Display name for the legend for this column (defaults to the column name).
Type:
- String
legendTicks :Integer
- Source:
- Inherited From:
How many horizontal ticks to draw on the generated color ramp legend, not counting the top or bottom.
Type:
- Integer
maxDisplayValue :Float
- Source:
- Inherited From:
All data values greater than or equal to this are considered equal for the purpose of display.
Type:
- Float
minDisplayValue :Float
- Source:
- Inherited From:
All data values less than or equal to this are considered equal for the purpose of display.
Type:
- Float
name :String
- Source:
- Inherited From:
Display name for this column.
Type:
- String
nullColor :String
- Source:
- Inherited From:
The css string for the color with which to display null values.
Type:
- String
nullLabel :String
- Source:
- Inherited From:
The legend label for null values.
Type:
- String
regionType :String
- Source:
The identifier of a region type, as used by RegionProviderList.
Type:
- String
regionVariable :String
- Source:
The name of the variable (column) to be used for region mapping.
Type:
- String
replaceWithNullValues :Array
- Source:
- Inherited From:
Values to replace with null, eg. ['na', 'NA'].
Type:
- Array
replaceWithZeroValues :Array
- Source:
- Inherited From:
Values to replace with zero, eg. ['-', null].
Type:
- Array
scale :Float
- Source:
- Inherited From:
The size of each point or billboard.
Type:
- Float
scaleByValue :Boolean
- Source:
- Inherited From:
Should points and billboards representing each feature be scaled by the size of their data variable?
Type:
- Boolean
timeColumn :String|Integer|Array.<String>|Array.<Integer>|null
- Source:
The column name or index to use as the time column. Defaults to the first one found. Pass null for none. Pass an array of two, eg. [0, 1], to provide both start and end date columns.
Type:
- String | Integer | Array.<String> | Array.<Integer> | null
type :String|Number
- Source:
- Inherited From:
The variable type of this column. Converts strings, which are case-insensitive keys of VarType, to numbers. See TableStructure for further information.
Type:
- String | Number
units :String
- Source:
- Inherited From:
The units of this column.
Type:
- String
xAxis :String|Integer
- Source:
The column name or index to use as the time column. Defaults to the first one found. Pass null for none. Pass an array of two, eg. [0, 1], to provide both start and end date columns.
Type:
- String | Integer
yAxisMax :Float
- Source:
- Inherited From:
Maximum y value to display in charts; if not specified, maximum data value will be used.
Type:
- Float
yAxisMin :Float
- Source:
- Inherited From:
Minimum y value to display in charts; if not specified, minimum data value will be used.
Type:
- Float