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

Geospatial data visualization platform.

import { TableStyleMapModel } from "../../../Table/TableStyleMap";
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 ScaleByDistanceTraits from "../ScaleByDistanceTraits";
import {
  BinStyleTraits,
  EnumStyleTraits,
  TableStyleMapSymbolTraits,
  TableStyleMapTraits
} from "./StyleMapTraits";

export class PointSymbolTraits extends mixTraits(TableStyleMapSymbolTraits) {
  @primitiveTrait({
    name: "Marker (icon)",
    description:
      'Marker used to symbolize points. Default is "point"/"circle". This can be a URL, [data URI](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs) or one of the supported [Maki icons](https://labs.mapbox.com/maki-icons/) (eg "hospital")',
    type: "string"
  })
  marker?: string = "point";

  @primitiveTrait({
    name: "Rotation",
    description: "Rotation of marker in degrees (clockwise).",
    type: "number"
  })
  rotation?: number = 0;

  @primitiveArrayTrait({
    name: "Pixel offset",
    description: "Pixel offset in screen space from the origin. [x, y] format",
    type: "number"
  })
  pixelOffset?: number[];

  @primitiveTrait({
    name: "Height",
    description: "Height of the marker (in pixels).",
    type: "number"
  })
  height?: number = 16;

  @primitiveTrait({
    name: "Width",
    description: "Width of the marker (in pixels).",
    type: "number"
  })
  width?: number = 16;

  @objectTrait({
    name: "Scale by distance",
    description:
      "Scales a point, billboard or label feature by its distance from the camera.",
    type: ScaleByDistanceTraits,
    isNullable: true
  })
  scaleByDistance?: ScaleByDistanceTraits;

  @primitiveTrait({
    name: "Disable depth test distance",
    description:
      "The distance from camera at which to disable depth testing, for example to prevent clipping of features againts terrain. Set to a very large value like 99999999 to disable depth testing altogether. When not defined or set to 0, depth testing is always applied.",
    type: "number"
  })
  disableDepthTestDistance?: number;
}

export class EnumPointSymbolTraits extends mixTraits(
  PointSymbolTraits,
  EnumStyleTraits
) {
  static isRemoval = EnumStyleTraits.isRemoval;
}

export class BinPointSymbolTraits extends mixTraits(
  PointSymbolTraits,
  BinStyleTraits
) {
  static isRemoval = BinStyleTraits.isRemoval;
}

export default class TablePointStyleTraits
  extends mixTraits(TableStyleMapTraits)
  implements TableStyleMapModel<PointSymbolTraits>
{
  @objectArrayTrait({
    name: "Enum point styles",
    description: "The point style to use for enumerated values.",
    type: EnumPointSymbolTraits,
    idProperty: "index"
  })
  enum: EnumPointSymbolTraits[] = [];

  @objectArrayTrait({
    name: "Bin point styles",
    description: "The point style to use for bin values.",
    type: BinPointSymbolTraits,
    idProperty: "index"
  })
  bin: BinPointSymbolTraits[] = [];

  @objectTrait({
    name: "Enum Colors",
    description: "The default point style.",
    type: PointSymbolTraits
  })
  null: PointSymbolTraits = new PointSymbolTraits();
}