Interface CoordinatesReadApi

Read helpers added to the CoordinatesDisplay control for integrators / studio.

interface CoordinatesReadApi {
isEnabled(): boolean;
getConfig(): CoordinatesCapabilityConfig;
}

Index

Methods

isEnabled getConfig

Methods

isEnabled

isEnabled(): boolean
Returns true when the readout is enabled (modules.coordinates.enabled !== false).

Returns boolean
- Defined in src/capabilities/coordinates/public-api.ts:24

getConfig

getConfig(): CoordinatesCapabilityConfig
Returns the resolved modules.coordinates config (merged over the built-in defaults).

Returns CoordinatesCapabilityConfig
- Defined in src/capabilities/coordinates/public-api.ts:26