Type Alias GeometryLineLabelConfig

Line label configuration for geometries.

When set, a symbol layer is added to the geometry source, placing labels along the polygon border lines

Example

// Defaults
const lineLabelConfig: GeometryLineLabelConfig = {};

// Custom appearance for dark fills
const lineLabelConfig: GeometryLineLabelConfig = {
  minZoom: 10,
  textColor: '#FFFFFF',
  textHaloColor: '#000000',
  textSize: 13
};

type GeometryLineLabelConfig = {
    minZoom?: number;
    symbolSpacing?: number;
    textColor?: DataDrivenPropertyValueSpecification<string>;
    textHaloColor?: DataDrivenPropertyValueSpecification<string>;
    textHaloWidth?: DataDrivenPropertyValueSpecification<number>;
    textOffset?: DataDrivenPropertyValueSpecification<[number, number]>;
    textOpacity?: DataDrivenPropertyValueSpecification<number>;
    textSize?: DataDrivenPropertyValueSpecification<number>;
}

Index

Properties

minZoom? symbolSpacing? textColor? textHaloColor? textHaloWidth? textOffset? textOpacity? textSize?

Properties

`Optional`minZoom

minZoom?: number

Minimum zoom level at which border labels are visible.

Default

`Optional`symbolSpacing

symbolSpacing?: number

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

Default

Example

symbolSpacing: 350

`Optional`textColor

textColor?: DataDrivenPropertyValueSpecification<string>

Color of the border label text.

Default

'#333333'

Example

textColor: '#FFFFFF'
textColor: ['get', 'labelColor']

`Optional`textHaloColor

textHaloColor?: DataDrivenPropertyValueSpecification<string>

Color of the halo drawn around the border label text.

The halo improves legibility against complex or dark backgrounds.

Default

'#FFFFFF'

Example

textHaloColor: '#000000'

`Optional`textHaloWidth

textHaloWidth?: DataDrivenPropertyValueSpecification<number>

Width of the halo drawn around the border label text, in pixels.

Default

Example

textHaloWidth: 3

`Optional`textOffset

textOffset?: DataDrivenPropertyValueSpecification<[number, number]>

Offset of the border label from the line, in ems [x, y].

Default

[0, 1]

Example

textOffset: [0, 1]  // Default: 1em above the line

`Optional`textOpacity

textOpacity?: DataDrivenPropertyValueSpecification<number>

Opacity of the border label text.

Default

Example

textOpacity: 0.8

`Optional`textSize

textSize?: DataDrivenPropertyValueSpecification<number>

Font size of the border labels in pixels.

Default

Example

textSize: 13
// Data-driven
textSize: ['interpolate', ['linear'], ['zoom'], 8, 12, 14, 16]

Type Alias GeometryLineLabelConfig

Example

Index

Properties

Properties

`Optional`minZoom

Default

`Optional`symbolSpacing

Default

Example

`Optional`textColor

Default

Example

`Optional`textHaloColor

Default

Example

`Optional`textHaloWidth

Default

Example

`Optional`textOffset

Default

Example

`Optional`textOpacity

Default

Example

`Optional`textSize

Default

Example

Settings

On This Page

Type Alias GeometryLineLabelConfig

Example

Index

Properties

Properties

OptionalminZoom

Default

OptionalsymbolSpacing

Default

Example

OptionaltextColor

Default

Example

OptionaltextHaloColor

Default

Example

OptionaltextHaloWidth

Default

Example

OptionaltextOffset

Default

Example

OptionaltextOpacity

Default

Example

OptionaltextSize

Default

Example

Settings

On This Page

`Optional`minZoom

`Optional`symbolSpacing

`Optional`textColor

`Optional`textHaloColor

`Optional`textHaloWidth

`Optional`textOffset

`Optional`textOpacity

`Optional`textSize