This is the documentation of version 1.0.0-rc.3. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ReachableRangeFillConfig

    The fill of the ReachableRangesModule bands.

    type ReachableRangeFillConfig = {
        outermostOpacityFactor?: number;
        palette?: string[];
        paletteMode?: GeometryPaletteMode;
        style?: GeometryFillStyle;
    }
    Index
    outermostOpacityFactor?: number

    Multiplier on the outermost band's fill opacity, 0 to 1. The bands between step evenly from the innermost one, drawn at the full opacity, so the bands fade out away from the origin.

    With 'inverted', the world beyond the largest range is the outermost band. A lone range is the outermost band too, so it takes the factor.

    1
    
    palette?: string[]

    CSS colours of the bands, the innermost band first, starting over after the last, or blended from the first to the last with paletteMode 'ramp'. An empty list counts as unset.

    Unset, the bands ramp from the map's accent toward its land colour, read from TomTomMap.mapColors:

    • The innermost band takes the accent, except with 'inverted', which deepens away from the origin.
    • A theme set with StylingFoundationsModule.setMapColors, such as the map-theme plugin's deriveMapColors, recolours the bands with the rest of the map.
    • Without a theme, the ramp runs from the style's light or dark default, '#0A3653' or '#5FA8D8', toward its land colour, or white or '#333333' until a styling foundations module publishes it.
    • Bands are ranked per origin, so with several origins the ranges of the same rank share a colour.
    paletteMode?: GeometryPaletteMode

    How palette colours the bands, innermost first: each the next colour in turn, or a step of an even blend from its first colour to its last. With 'ramp', two colours shade any number of bands.

    'cycle'
    

    How the bands are filled.

    • 'filled' — each band coloured, the innermost on top.
    • 'outline' — only each range's border, thick and coloured.
    • 'inverted' — the area outside each range coloured: the world beyond the largest range, then a ring between each range and the next smaller one.
    'filled'