Theming

The map style can be customized in a number of ways to fit into your branding & use case, or to set vehicle-specific parameters such as safety contour values.

There are two types of theming in the Vector Charts APIs:

  • Query Parameters: Change user-specific options such as safety contours and day/night mode.
  • Custom Style: Complete customization of all layers and color schemes to match your branding and choose which data is relevant to your use case.

Query Parameters

The style returned using the Get Vector Style endpoint has a limited set of options designed to change the style of the map at runtime.

The Get Vector Style API page has a complete list of parameters.

Depth Limit

The depthLimit parameter controls the ENC safety contour and should be set to the depth considered safe for navigation by your vehicle.

For example, changing depthLimit to 1, 3, and 10:

https://api.vectorcharts.com/api/v1/styles/base.json?token=<token>&depthLimit=1 theming1

https://api.vectorcharts.com/api/v1/styles/base.json?token=<token>&depthLimit=3 theming1

https://api.vectorcharts.com/api/v1/styles/base.json?token=<token>&depthLimit=10 theming1

Day & Night Theme

The theme parameter determines which color palette to use. Each stylesheet has a day, dusk and night color palette.

https://api.vectorcharts.com/api/v1/styles/base.json?token=<token>&theme=day theming1

https://api.vectorcharts.com/api/v1/styles/base.json?token=<token>&theme=dusk theming1

https://api.vectorcharts.com/api/v1/styles/base.json?token=<token>&theme=night theming1

Custom Styles

Enterprise customers gain access to the Style Editor, which gives complete control over map layers & color palettes.

Contact Us to learn more about custom styles.

VectorCharts.com © 2024, Full Hex Ventures, LLC · vectorcharts.com