Home > @magiclane/maps-sdk > OverlayItem > getPreviewExtendedData
OverlayItem.getPreviewExtendedData() method
Get extended preview data asynchronously for the overlay item.
Signature:
getPreviewExtendedData(onResult: (err: GemError, params: SearchableParameterList | null) => void, filter?: PTStopScheduleFilter): any;Parameters
Parameter | Type | Description |
|---|---|---|
onResult | (err: GemError, params: SearchableParameterList | null) => void | Callback function invoked with (error, parameters) when complete |
filter | (Optional) Optional departures filter (public transport items only). Narrows only the trips (departures) section of the preview extended data - the stops[].routes[] line catalogue is always returned complete. An empty / omitted filter produces the legacy, unfiltered request. An inconsistent filter is rejected with GemError.invalidInput before any request is sent (see PTStopScheduleFilter). |
Returns:
any
The EventDrivenProgressListener that identifies this operation, or null if it couldn't be started
Exceptions
An exception if it fails