terriajs/lib/Traits/TraitsClasses/Table/TableTraits.ts

Geospatial data visualization platform.

import objectArrayTrait from "../../Decorators/objectArrayTrait";
import objectTrait from "../../Decorators/objectTrait";
import primitiveArrayTrait from "../../Decorators/primitiveArrayTrait";
import primitiveTrait from "../../Decorators/primitiveTrait";
import mixTraits from "../../mixTraits";
import ChartPointOnMapTraits from "../ChartPointOnMapTraits";
import DiscretelyTimeVaryingTraits from "../DiscretelyTimeVaryingTraits";
import ExportableTraits from "../ExportableTraits";
import LayerOrderingTraits from "../LayerOrderingTraits";
import LegendOwnerTraits from "../LegendOwnerTraits";
import OpacityTraits from "../OpacityTraits";
import SplitterTraits from "../SplitterTraits";
import TableColumnTraits from "./ColumnTraits";
import TableStyleTraits from "./StyleTraits";

export default class TableTraits extends mixTraits(
  DiscretelyTimeVaryingTraits,
  ExportableTraits,
  LayerOrderingTraits,
  OpacityTraits,
  SplitterTraits,
  ChartPointOnMapTraits,
  LegendOwnerTraits
) {
  // Not implemented in v8
  @primitiveTrait({
    name: "Show Warning for Unmatched Regions",
    description:
      "True to show a warning when some of the region IDs in the CSV file could not be matched to a region. False to silently ignore unmatched regions.",
    type: "boolean"
  })
  showUnmatchedRegionsWarning: boolean | undefined = true;

  @objectArrayTrait({
    name: "Columns",
    description: "Options for individual columns/variables.",
    type: TableColumnTraits,
    idProperty: "name"
  })
  columns?: TableColumnTraits[];

  @objectTrait({
    name: "Default Column",
    description: "The default settings to use for all columns/variables",
    type: TableColumnTraits
  })
  defaultColumn?: TableColumnTraits;

  @objectArrayTrait({
    name: "Styles",
    description:
      "The set of styles that can be used to visualize this dataset.",
    type: TableStyleTraits,
    idProperty: "id"
  })
  styles?: TableStyleTraits[];

  @objectTrait({
    name: "Default Style",
    description:
      "The default style to apply when visualizing any column/variable.",
    type: TableStyleTraits
  })
  defaultStyle?: TableStyleTraits;

  @primitiveTrait({
    name: "Selected Style",
    description: "The ID of the currently-selected style.",
    type: "string"
  })
  activeStyle?: string;

  @primitiveTrait({
    name: "Enable manual region mapping",
    description:
      "If enabled, there will be controls to set region column/variable and region type.",
    type: "boolean"
  })
  enableManualRegionMapping?: boolean | undefined;

  @primitiveTrait({
    name: "Show disable styling option",
    description:
      "If enabled, there will be an option in styleDimension to disable styling.",
    type: "boolean"
  })
  showDisableStyleOption?: boolean | undefined;

  @primitiveTrait({
    name: "Show disable time",
    description: "If enabled, there will be an checkbox to disable time.",
    type: "boolean"
  })
  showDisableTimeOption?: boolean | undefined;

  @primitiveArrayTrait({
    name: "Column titles",
    description:
      "An optional array of column/variable titles that override the individual `TableColumnTraits.title` setting.",
    type: "string"
  })
  columnTitles: string[] = [];

  @primitiveArrayTrait({
    name: "Column units",
    description:
      "An optional array of column/variable units that override the individual `TableColumnTraits.unit` setting.",
    type: "string"
  })
  columnUnits: string[] = [];

  @primitiveTrait({
    name: "Remove duplicate rows",
    type: "boolean",
    description:
      "If two rows in the table are identical, only retain one copy. This could cause performance issues, and so should be used only when absolutely necessary."
  })
  removeDuplicateRows: boolean = false;
}