Options
All
  • Public
  • Public/Protected
  • All
Menu

An object literal containing the ParameterizedLinePainter's parameters.

Hierarchy

  • ParameterizedLinePainterConstructorOptions

Overview

Properties

Optional defaultColor

defaultColor: string | null

The default line color, represented as a CSS color string.

Optional draped

draped: boolean

Whether to drape the lines on terrain or not.

default

false.

Optional lineType

lineType: LineType

Determines how lines between subsequent points will be interpreted.

Optional lineWidth

lineWidth: number

The line width, in pixels.

default

1.

Optional properties

properties: string[]

The list of property names that will be used in the ParameterizedLinePainter.propertyColorExpressions. If a property is ever to be used in the ParameterizedLinePainter.propertyColorExpressions, it must be listed in this array.

Optional propertyColorExpressions

propertyColorExpressions: PropertyColorExpression[]

An array of objects describing a mapping of property values to colors. See ParameterizedLinePainter.propertyColorExpressions.

Optional rangeColorMap

rangeColorMap: ColorMap | null

The ColorMap that maps a range value to a modulation color. null (the default) to disable.

Optional rangePropertyProvider

rangePropertyProvider: (feature: Feature, shape: Shape, pointIndex: number) => number

A function that returns a range value as a number for a given point on a line. The user of this class is free to choose the range of values. If no rangePropertyProvider is passed, range filtering is disabled (rangeWindow will be ignored). You can not modify the rangePropertyProvider after the ParameterizedLinePainter has been constructed.

param

The feature for which to determine a value.

param

The shape for which to determine a value.

param

The index of the point in the shape for which to determine a value.

Type declaration

    • (feature: Feature, shape: Shape, pointIndex: number): number
    • Parameters

      Returns number

Optional rangeWindow

rangeWindow: [number, number]

The start / end value for range filtering as an array with two values.

Optional selectionColor

selectionColor: string | null

The color to paint selected lines with, represented as a CSS color string.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method