Skip to content

setRTLTextPlugin()

setRTLTextPlugin(pluginURL: string, lazy: boolean): Promise<void>

Defined in: src/index.ts:69

Sets the map's RTL text plugin. Necessary for supporting the Arabic and Hebrew languages, which are written right-to-left.

Parameters

ParameterTypeDescription
pluginURLstringURL pointing to the Mapbox RTL text plugin source.
lazybooleanIf set to true, mapmetrics will defer loading the plugin until rtl text is encountered, rtl text will then be rendered only after the plugin finishes loading.

Returns

Promise<void>

Example

ts
setRTLTextPlugin('https://unpkg.com/@mapbox/mapbox-gl-rtl-text@0.3.0/dist/mapbox-gl-rtl-text.js', false);

See

Add support for right-to-left scripts