Class EdgeInsets

An EdgeInset object represents screen space padding applied to the edges of the viewport. This shifts the apprent center or the vanishing point of the map. This is useful for adding floating UI elements on top of the map and having the vanishing point shift as UI elements resize.

Properties

bottom left right top

Methods

getCenter interpolate toJSON

Properties

bottom

bottom: number

Default Value

0

left

left: number

Default Value

0

right

right: number

Default Value

0

top

top: number

Default Value

0

Methods

getCenter

  • getCenter(width, height): Point

  • Utility method that computes the new apprent center or vanishing point after applying insets. This is in pixels and with the top left being (0.0) and +y being downwards.

    Parameters

    • width: number

      the width

    • height: number

      the height

    Returns Point

    the point

interpolate

  • interpolate(start, target, t): EdgeInsets

  • Interpolates the inset in-place. This maintains the current inset value for any inset not present in target.

    Parameters

    Returns EdgeInsets

    the insets

toJSON

  • toJSON(): PaddingOptions

  • Returns the current state as json, useful when you want to have a read-only representation of the inset.

    Returns PaddingOptions

    state as json

Settings

Member Visibility

Theme

On This Page

bottomleftrighttopgetCenterinterpolatetoJSON