Server Attributes Data Dto Reference

The ThingsTelemetry\Traccar\Dto\ServerAttributesData represents the configurable preferences and UI behavior of a Traccar server instance. It provides structured access to map display settings, unit preferences, API keys, and user interface controls defined in the Traccar configuration.

WARNING

These attributes may not be exhaustively documented. Please let us know if you find any missing attributes or better make a PR.

use ThingsTelemetry\Traccar\Facades\Server;

$attributes = Server::get()->attributes;

language → string|null

Preferred interface language for the server UI.

$attributes->language; // "en"

mapGeofences → boolean

If true, displays geofences on the server map.

$attributes->mapGeofences; // true

mapLiveRoutes → string|null

Specifies the live route line color or style for map visualization.

$attributes->mapLiveRoutes; // "#0099FF"

mapDirection → string|null

Determines whether to show directional arrows on map routes.

$attributes->mapDirection; // "arrows"

mapFollow → boolean

If true, the map automatically follows active device movement.

$attributes->mapFollow; // true

mapCluster → boolean

Enables clustering of devices on the map for better visibility.

$attributes->mapCluster; // true

mapOnSelect → boolean

If true, selecting a device pans the map to its location.

$attributes->mapOnSelect; // false

activeMapStyles → string|null

Specifies the active map style or theme (e.g., “dark”, “satellite”).

$attributes->activeMapStyles; // "dark"

devicePrimary → string|null

Primary device attribute to show in the list view.

$attributes->devicePrimary; // "name"

deviceSecondary → string|null

Secondary attribute displayed under device name.

$attributes->deviceSecondary; // "status"

soundEvents → mixed

Event notification sound identifier.

$attributes->soundEvents; // "??"

soundAlarms → mixed

Alarm notification sound file or key.

$attributes->soundAlarms; // "??"

positionItems → string|null

Defines how position items are displayed (e.g., “table” or “list”).

$attributes->positionItems; // "table"

googleKey, locationIqKey, mapboxAccessToken, mapTilerKey, bingMapsKey, openWeatherKey, tomTomKey, hereKey → string|null

API keys for external integrations such as maps, weather, and geocoding services.

$attributes->mapboxAccessToken; // "MAPBOX_TOKEN"

notificationTokens → string|null

Comma-separated tokens for push notification services.

$attributes->notificationTokens; // "TOKEN1,TOKEN2"

uiDisableSavedCommands, uiDisableGroups, uiDisableAttributes, uiDisableEvents, uiDisableVehicleFeatures, uiDisableDrivers, uiDisableComputedAttributes, uiDisableCalendars, uiDisableMaintenance → boolean

Flags controlling which UI sections or features are hidden/disabled in the web interface.

$attributes->uiDisableGroups; // false

disableShare → boolean

Disable Device Sharing

$attributes->disableShare; // false

darkMode → boolean

Enable Dark Mode for the Traccar web UI.

$attributes->darkMode; // false

webLiveRouteLength → integer|null

Maximum number of points to render in live routes.

$attributes->webLiveRouteLength; // 1000

mapLineWidth → float|null

Width of lines drawn for device routes on the map.

$attributes->mapLineWidth; // 2.5

mapLineOpacity → float|null

Opacity (0–1) of map route lines.

$attributes->mapLineOpacity; // 0.8

webSelectZoom → integer|null

Default zoom level when selecting a device.

$attributes->webSelectZoom; // 15

webMaxZoom → integer|null

Maximum zoom level allowed in the web UI map.

$attributes->webMaxZoom; // 19

iconScale → float|null

Scaling factor for map device icons.

$attributes->iconScale; // 1.2

navigationAppLink → string|null

Custom deep link for external navigation apps.

$attributes->navigationAppLink; // "geo:{lat},{lon}"

navigationAppTitle → string|null

Display title for the external navigation app.

$attributes->navigationAppTitle; // "Google Maps"

speedUnit → SpeedUnit

Speed measurement unit (e.g., knots, km/h, mph).

$attributes->speedUnit->value; // "kn"

distanceUnit → DistanceUnit

Distance measurement unit for reports and map metrics.

$attributes->distanceUnit->label(); // "Kilometers"

altitudeUnit → AltitudeUnit

Preferred unit for altitude readings.

$attributes->altitudeUnit->value; // "m"

volumeUnit → VolumeUnit

Volume measurement unit (used in fuel level sensors, etc.).

$attributes->volumeUnit->value; // "l"

timezone → string

Default timezone for server and reports.

$attributes->timezone; // "Africa/Nairobi"

IMPORTANT

Null boolean attributes defaults to false.