Type Alias GeometryLineLabelConfig

GeometryLineLabelConfig: GeometryLabelConfig & {
    minZoom?: number;
    offset?: DataDrivenPropertyValueSpecification<[number, number]>;
    symbolSpacing?: number;
}

Labels placed along the polygon border lines, with the center label's fields plus where along the border they repeat.

When set, the border labels are drawn, including when set after the module is created.

Type Declaration

OptionalminZoom?: number

Minimum zoom level at which border labels are visible.
Default
```
3
```
Optionaloffset?: DataDrivenPropertyValueSpecification<[number, number]>

Offset of the border label from the line, in ems [x, y].
Default
```
[0, 1]
```
Example
```
offset: [0, 1]  // Default: 1em above the line
```
OptionalsymbolSpacing?: number

Distance between repeated labels along the border line, in pixels.
Default
```
200
```

Remarks

Defaults for the unset fields:

title the feature's own title, minZoom 3, size 15, haloWidth 2, symbolSpacing 200, opacity 1, offset [0, 1], bold font.
color and haloColor are theme-adaptive: '#333333' text with a '#FFFFFF' halo on light map styles, the reverse on dark.

Example

// Defaults
const lineLabel: GeometryLineLabelConfig = {};

// Custom text and appearance for dark fills
const lineLabel: GeometryLineLabelConfig = {
  title: ['get', 'name'],
  minZoom: 10,
  color: '#FFFFFF',
  haloColor: '#000000',
  size: 13
};

Type Alias GeometryLineLabelConfig

Type Declaration

`Optional`minZoom?: number

Default

`Optional`offset?: DataDrivenPropertyValueSpecification<[number, number]>

Default

Example

`Optional`symbolSpacing?: number

Default

Remarks

Example

Settings

Type Alias GeometryLineLabelConfig

Type Declaration

OptionalminZoom?: number

Default

Optionaloffset?: DataDrivenPropertyValueSpecification<[number, number]>

Default

Example

OptionalsymbolSpacing?: number

Default

Remarks

Example

Settings

`Optional`minZoom?: number

`Optional`offset?: DataDrivenPropertyValueSpecification<[number, number]>

`Optional`symbolSpacing?: number