Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines a format string to be used at a given scale range.

since

2022.0

Hierarchy

  • OverlayTextSetting

Overview

Properties

Properties

format

format: string

scaleRange

scaleRange: { max: number; min: number }

The scale range in which to apply the format string.

min should be smaller than max. Smaller numbers represent more zoomed out scales, larger number represent more zoomed in scales. 0 represents the scale of a map zoomed out to infinity. Number.MAX_VALUE represents the scale of a map that's zoomed in to the maximum.

Type declaration

  • max: number
  • min: number

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