TableColumnStyle

TableColumnStyle

new TableColumnStyle(optionsopt)

Source:

A set of properties that define how a table column 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.

Properties
Name Type Attributes Description
minDisplayValue Float <optional>

All data values less than or equal to this are considered equal for the purpose of display.
yAxisMin Float <optional>

Minimum y value to display in charts; if not specified, minimum data value will be used.
yAxisMax Float <optional>

Maximum y value to display in charts; if not specified, maximum data value will be used.
maxDisplayValue Float <optional>

All data values reater than or equal to this are considered equal for the purpose of display.
displayDuration Float <optional>

Display duration for each row in the table, in minutes. If not provided, this is estimated from the data.
replaceWithZeroValues Array <optional>

Values to replace with zero, eg. ['-', null] will replace '-' and empty values with 0.
replaceWithNullValues Array <optional>

Values to replace with null, eg. ['na', 'NA'] will replace these values with null.
nullColor String <optional>

The css string for the color with which to display null values.
nullLabel String <optional>

The legend label for null values.
scale Float <optional>

The size of each point or billboard.
scaleByValue Boolean <optional>

Should points and billboards representing each feature be scaled by the size of their data variable?
clampDisplayValue Boolean <optional>

Display values that fall outside the display range as min and max colors.
imageUrl String <optional>

A string representing an image to display at each point, for lat-long datasets.
featureInfoFields Object <optional>

An object of { "myCol": "My column" } properties, defining which columns get displayed in feature info boxes and what label is used instead of the column's actual name.
chartLineColor String <optional>

Override color for column for charts.
colorBins Integer | Array.<Number> <optional>

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.
colorBinMethod String <optional>

The method for quantising colors: "auto" (default), "ckmeans", "quantile" or "none" (equivalent to colorBins: 0).
colorMap String | Array <optional>

Gets or sets a string or ColorMap array, specifying how to map values to colors. Setting this property sets colorPalette to undefined. If this property is a string, it specifies a list of CSS colors separated by hyphens (-), and the colors are evenly spaced over the range of values. For example, "red-white-hsl(240,50%,50%)".
colorPalette String <optional>

Gets or sets the ColorBrewer palette to use when mapping values to colors. Setting this property sets colorMap to undefined. This property is ignored if colorMap is defined.
legendTicks Integer <optional>

How many horizontal ticks to draw on the generated color ramp legend, not counting the top or bottom.
name String <optional>

Display name for this column.
legendName String <optional>

Display name for this column to use for the legend (defaults to the column name).
type String | Number <optional>

The variable type of this column. Should be one of the keys of VarType (case-insensitive), eg. 'ENUM', 'SCALAR', 'TIME'.
units String <optional>

Display units for this column. Currently only displayed in charts.
active Boolean <optional>

Is this column active?

Members

active :Boolean

Source:

Is this column active?

Type:
  • Boolean

chartLineColor :String

Source:

Color for column (css string)

Type:
  • String

clampDisplayValue :Boolean

Source:

Display values that fall outside the display range as min and max colors.

Type:
  • Boolean

colorBinMethod :String

Source:

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:

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>

displayDuration :Float

Source:

Display duration for each row in the table, in minutes. If not provided, this is estimated from the data.

Type:
  • Float

featureInfoFields :Object

Source:

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:

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:

A string representing an image to display at each point, for lat-long datasets.

Type:
  • String

legendName :String

Source:

Display name for the legend for this column (defaults to the column name).

Type:
  • String

legendTicks :Integer

Source:

How many horizontal ticks to draw on the generated color ramp legend, not counting the top or bottom.

Type:
  • Integer

maxDisplayValue :Float

Source:

All data values greater than or equal to this are considered equal for the purpose of display.

Type:
  • Float

minDisplayValue :Float

Source:

All data values less than or equal to this are considered equal for the purpose of display.

Type:
  • Float

name :String

Source:

Display name for this column.

Type:
  • String

nullColor :String

Source:

The css string for the color with which to display null values.

Type:
  • String

nullLabel :String

Source:

The legend label for null values.

Type:
  • String

replaceWithNullValues :Array

Source:

Values to replace with null, eg. ['na', 'NA'].

Type:
  • Array

replaceWithZeroValues :Array

Source:

Values to replace with zero, eg. ['-', null].

Type:
  • Array

scale :Float

Source:

The size of each point or billboard.

Type:
  • Float

scaleByValue :Boolean

Source:

Should points and billboards representing each feature be scaled by the size of their data variable?

Type:
  • Boolean

type :String|Number

Source:

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:

The units of this column.

Type:
  • String

yAxisMax :Float

Source:

Maximum y value to display in charts; if not specified, maximum data value will be used.

Type:
  • Float

yAxisMin :Float

Source:

Minimum y value to display in charts; if not specified, minimum data value will be used.

Type:
  • Float