Interface MarkerListApi

interface MarkerListApi {
    onMarkerAction$: Observable<MarkerListActionEvent>;
    onMarkerClick$: Observable<MarkerListClickEvent>;
    onMarkerCreate$: Observable<MarkerCreateEvent>;
    onMarkerDelete$: Observable<MarkerDeleteEvent>;
    onMarkerInit$: Observable<MarkerInitEvent>;
    onMarkerUpdate$: Observable<MarkerUpdateEvent>;
    onVttLoaded$: Observable<undefined | MarkerVttFile>;
    get name(): string;
    addMarker(marker: Partial<MarkerApi>): MarkerApi;
    destroy(): void;
    getMarkers(): MarkerApi[];
    getSelectedMarker(): undefined | MarkerApi;
    removeMarker(id: string): void;
    toggleMarker(id: string): void;
    updateMarker(id: string, data: Partial<MarkerApi>): void;
}

Hierarchy

  • MarkerAwareApi
    • MarkerListApi

Properties

onMarkerAction$ onMarkerClick$ onMarkerCreate$ onMarkerDelete$ onMarkerInit$ onMarkerUpdate$ onVttLoaded$

Accessors

name

Methods

addMarker destroy getMarkers getSelectedMarker removeMarker toggleMarker updateMarker

Properties

onMarkerAction$

onMarkerAction$: Observable<MarkerListActionEvent>

Fires after a custom action element is clicked

onMarkerClick$

onMarkerClick$: Observable<MarkerListClickEvent>

Fires after a marker list item row is clicked

ReadonlyonMarkerCreate$

onMarkerCreate$: Observable<MarkerCreateEvent>

Fires on marker create

ReadonlyonMarkerDelete$

onMarkerDelete$: Observable<MarkerDeleteEvent>

Fires on marker delete

ReadonlyonMarkerInit$

onMarkerInit$: Observable<MarkerInitEvent>

Fires on loading the initial list of markers

ReadonlyonMarkerUpdate$

onMarkerUpdate$: Observable<MarkerUpdateEvent>

Fires on marker update

onVttLoaded$

onVttLoaded$: Observable<undefined | MarkerVttFile>

Fires after VTT file defined in the config is loaded

Accessors

name

Methods

addMarker

  • addMarker(marker): MarkerApi

  • Adds a new marker

    Parameters

    • marker: Partial<MarkerApi>

      Marker Data

    Returns MarkerApi

destroy

getMarkers

getSelectedMarker

removeMarker

toggleMarker

updateMarker

  • updateMarker(id, data): void

  • Updates Marker by ID

    Parameters

    • id: string

      Marker ID

    • data: Partial<MarkerApi>

    Returns void

Settings

Member Visibility

On This Page

Properties
Accessors
Methods