• Public
  • Public/Protected
  • All

A BorderStyle describes how the inner or outer border of a closed shape is rendered.

Borders are rendered only for closed shapes, for instance: polygon, circle, ellipse, buffer, arc band. Non-closed shapes, such as polylines, points, or arcs, are painted without border. Extruded shapes are visualized with borders only on 2D maps.

The inner border stroke is drawn on the inner side of shape and the outer border stroke is drawn on the outer side of shape. If shape style is defined with the fill, stroke, inner and outer border style then the borders are drawn after rendering the fill style and before rendering the stroke style.

Border Painter



// ShapeStyle object literal that uses Border style to draw inner and outer border
var style = {
  innerBorder: {
    color: "rgba(12, 2, 110, 0.25)",
    width: 12
  outerBorder: {
    color: "rgba(12, 2, 110, 0.5)",
    width: 3
  stroke: { width: 2 }


  • BorderStyle





color: string

The CSS color string of the border.

Optional uom

The uom determines the interpretation of the width as pixels or as a ground unit that represents the actual size of real-world objects, like for example meter of foot.

Supported UnitOfMeasures are:

  • UnitOfMeasureRegistry.getUnitOfMeasure("Pixels")
  • UnitOfMeasure of type QuantityKindRegistry.getQuantityKind("Length")

The uom property is only taken into account on geographically referenced maps.

The property is optional and the default value is the Pixel unit.


width: number

The width of the border.


  • 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