TomTom Maps SDK for JavaScript
This is the documentation of version 0.62.2. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias GeometryLineConfig

    Line/border configuration for geometries — the outline color, opacity and width.

    The curated fields cover the common cases; layers.line takes any other line property (line-gap-width, line-cap, line-dasharray, …).

    // Curated fields
    const line: GeometryLineConfig = { color: '#333333', width: 2, opacity: 0.8 };

    // Data-driven border
    const line: GeometryLineConfig = {
      color: ['get', 'borderColor'],
      width: ['case', ['get', 'selected'], 4, 2],
    };
    type GeometryLineConfig = {
        color?: DataDrivenPropertyValueSpecification<string>;
        layer?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>;
        opacity?: DataDrivenPropertyValueSpecification<number>;
        width?: DataDrivenPropertyValueSpecification<number>;
    }
    Index
    color? layer? opacity? width?
    color?: DataDrivenPropertyValueSpecification<string>

    Border/outline color: a hex string or a MapLibre expression (e.g. ['get', 'borderColor']).

    Overrides a feature's color property, fill.color, fill.palette and the top-level GeometriesModuleConfig.color for the border.

    layer?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

    A partial MapLibre line layer merged onto the border, under the curated fields above: they take precedence over the same paint properties set here.

    Use layers.line, which takes precedence over the curated fields, as every module's layers entry does.

    opacity?: DataDrivenPropertyValueSpecification<number>

    Border opacity, 0 (transparent) to 1 (opaque). Also accepts a MapLibre expression.

    1
    width?: DataDrivenPropertyValueSpecification<number>

    Border width in pixels. Also accepts a MapLibre expression (e.g. ['case', ['get', 'selected'], 4, 2]).

    2

    Settings
    Member Visibility

    On This Page
    Properties