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 RESOLVED against the pointer: an absent key is true on a fine pointer and false under (pointer: coarse).

Returns boolean
- Defined in packages/core/src/capabilities/coordinates/public-api.ts:28

getConfig

getConfig(): CoordinatesCapabilityConfig
Returns the modules.coordinates config merged over the built-in defaults, with enabled resolved against the pointer (see CoordinatesReadApi.isEnabled).

Returns CoordinatesCapabilityConfig
- Defined in packages/core/src/capabilities/coordinates/public-api.ts:33