LuciadRIA (2026.0.07)
    Preparing search index...

    Interface ParameterizedLinePainterConstructorOptions

    An object literal containing the ParameterizedLinePainter's parameters.

    interface ParameterizedLinePainterConstructorOptions {
        defaultColor?: string | null;
        draped?: boolean;
        drapeTarget?: DrapeTarget;
        lineType?: LineType;
        lineWidth?: number;
        properties?: string[];
        propertyColorExpressions?: PropertyColorExpression[];
        rangeColorMap?: ColorMap | null;
        rangePropertyProvider?: (
            feature: Feature,
            shape: Shape,
            pointIndex: number,
        ) => number;
        rangeWindow?: [number, number];
        selectionColor?: string | null;
    }

    Properties

    defaultColor? draped? drapeTarget? lineType? lineWidth? properties? propertyColorExpressions? rangeColorMap? rangePropertyProvider? rangeWindow? selectionColor?

    Properties

    defaultColor?: string | null

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

    draped?: boolean

    Whether these lines should be draped on top of the terrain or not.

    This property only exists for backwards compatibility. You should use drapeTarget instead. false is equivalent to DrapeTarget.NOT_DRAPED and true is equivalent to DrapeTarget.TERRAIN.

    false

    Use drapeTarget instead.

    drapeTarget?: DrapeTarget

    Whether these lines should be draped on top of the terrain or a 3D tiles mesh (or both).

    DrapeTarget.NOT_DRAPED

    2022.1

    lineType?: LineType

    Determines how lines between subsequent points will be interpreted.

    lineWidth?: number

    The line width, in pixels.

    1.
    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.

    propertyColorExpressions?: PropertyColorExpression[]

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

    rangeColorMap?: ColorMap | null

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

    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.

    Type Declaration

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

      • Parameters

        • feature: Feature

          The feature for which to determine a value.

        • shape: Shape

          The shape for which to determine a value.

        • pointIndex: number

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

        Returns number

    rangeWindow?: [number, number]

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

    selectionColor?: string | null

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

    Settings

    Member Visibility

    On This Page

    Properties