Class UserInteractions

Index

Constructors

Accessors

minimap pathManager

Methods

abortAnnotationEvent activateFeature activateLineFeatures addAnnotationFeature addCloseControl addDatasetMarkers addImage addLayeredMarker addMarker changeAnnotationDrawMode clearAnnotationFeatures clearDatasetMarkers clearMarkers clearSearchResults clearVisibilityFilter commitAnnotationEvent enableConnectivityByTaxonIds enableFeature enableFeatureResetOnClick enableFeatureWithChildren enableFlightPaths enableLayer enableMapFeature enableNeuronPathsByNerve enablePanZoomEvents enablePathsBySystem enablePathsByType enableSckanPaths enableSystem excludeAnnotated getFeatureState getLayers getNerveDetails getState getSystems mapFeature mapFeatureFromAnnotation markerEvent markerPosition nextMarkerId nodePathModels pathFeatureIds pathModelNodes refreshAnnotationFeatureGeometry removeAnnotationFeature removeCloseControl removeDatasetMarker removeImage removeMarker removePopup reset rollbackAnnotationEvent selectFeature selectFeatures setFeatureAnnotated setPaint setState setVisibilityFilter showAnnotator showMarkerPopup showPopup showSearchResults unselectFeature unselectFeatures visibleMarkerAnatomicalIds zoomToFeatures

Constructors

constructor

new UserInteractions(flatmap: FlatMap): UserInteractions
Parameters
- flatmap: FlatMap
Returns UserInteractions
- Defined in src/interactions.ts:198

Accessors

minimap

get minimap(): MinimapControl
Returns MinimapControl
- Defined in src/interactions.ts:358

pathManager

get pathManager(): PathManager
Returns PathManager
- Defined in src/interactions.ts:364

Methods

abortAnnotationEvent

abortAnnotationEvent(event: AnnotationEvent): void
Parameters
- event: AnnotationEvent
Returns void
- Defined in src/interactions.ts:435

activateFeature

activateFeature(feature: MapFeature | MapRenderedFeature): void
Parameters
- feature: MapFeature | MapRenderedFeature
Returns void
- Defined in src/interactions.ts:782

activateLineFeatures

activateLineFeatures(lineFeatures: MapPointFeature[]): void
Parameters
- lineFeatures: MapPointFeature[]
Returns void
- Defined in src/interactions.ts:793

addAnnotationFeature

addAnnotationFeature(feature: AnnotatedFeature): void
Parameters
- feature: AnnotatedFeature
Returns void
- Defined in src/interactions.ts:467

addCloseControl

addCloseControl(): void
Returns void
- Defined in src/interactions.ts:370

addDatasetMarkers

addDatasetMarkers(datasets: DatasetTerms[]): void
Parameters
- datasets: DatasetTerms[]
Returns void
- Defined in src/interactions.ts:1689

addImage

addImage(anatomicalId: any, imageUrl: any, _options?: {}): string
Parameters
- anatomicalId: any
- imageUrl: any
- _options: {} = {}
Returns string
- Defined in src/interactions.ts:1872

addLayeredMarker

addLayeredMarker(anatomicalId: string, options?: FlatMapMarkerOptions): number[]
Parameters
- anatomicalId: string
- options: FlatMapMarkerOptions = {}
Returns number[]
- Defined in src/interactions.ts:1588

addMarker

addMarker(anatomicalId: string, options?: FlatMapMarkerOptions): number
Parameters
- anatomicalId: string
- options: FlatMapMarkerOptions = {}
Returns number
- Defined in src/interactions.ts:1605

changeAnnotationDrawMode

changeAnnotationDrawMode(mode: AnnotationDrawMode): void
Parameters
- mode: AnnotationDrawMode
Returns void
- Defined in src/interactions.ts:483

clearAnnotationFeatures

clearAnnotationFeatures(): void
Returns void
- Defined in src/interactions.ts:451

clearDatasetMarkers

clearDatasetMarkers(): void
Returns void
- Defined in src/interactions.ts:1697

clearMarkers

clearMarkers(): void
Returns void
- Defined in src/interactions.ts:1663

clearSearchResults

clearSearchResults(_reset?: boolean): void
Parameters
- _reset: boolean = true
Returns void
- Defined in src/interactions.ts:857

clearVisibilityFilter

clearVisibilityFilter(): void
Returns void
- Defined in src/interactions.ts:1458

commitAnnotationEvent

commitAnnotationEvent(event: AnnotationEvent): void
Parameters
- event: AnnotationEvent
Returns void
- Defined in src/interactions.ts:427

enableConnectivityByTaxonIds

enableConnectivityByTaxonIds(
taxonIds: string | string[],
enable?: boolean,
): void
Parameters
- taxonIds: string | string[]
- enable: boolean = true
Returns void
- Defined in src/interactions.ts:1516

enableFeature

enableFeature(featureId: number, enable?: boolean, force?: boolean): void
Parameters
- featureId: number
- enable: boolean = true
- force: boolean = false
Returns void
- Defined in src/interactions.ts:655

enableFeatureResetOnClick

enableFeatureResetOnClick(enable?: boolean): void
Parameters
- enable: boolean = true
Returns void
- Defined in src/interactions.ts:1523

enableFeatureWithChildren

enableFeatureWithChildren(
    featureId: number,
    enable?: boolean,
    force?: boolean,
): void
Parameters
- featureId: number
- enable: boolean = true
- force: boolean = false
Returns void
- Defined in src/interactions.ts:669

enableFlightPaths

enableFlightPaths(enable?: boolean): void
Parameters
- enable: boolean = true
Returns void
- Defined in src/interactions.ts:544

enableLayer

enableLayer(layerId: string, enable?: boolean): void
Parameters
- layerId: string
- enable: boolean = true
Returns void
- Defined in src/interactions.ts:538

enableMapFeature

enableMapFeature(feature: MapFeature, enable?: boolean): void
Parameters
- feature: MapFeature
- enable: boolean = true
Returns void
- Defined in src/interactions.ts:637

enableNeuronPathsByNerve

enableNeuronPathsByNerve(
    nerveModels: string | string[],
    enable?: boolean,
    showCentreline?: boolean,
): void
Parameters
- nerveModels: string | string[]
- enable: boolean = true
- showCentreline: boolean = false
Returns void
- Defined in src/interactions.ts:1939

enablePanZoomEvents

enablePanZoomEvents(enabled?: boolean): void
Parameters
- enabled: boolean = true
Returns void
- Defined in src/interactions.ts:1845

enablePathsBySystem

enablePathsBySystem(system: any, enable?: boolean, force?: boolean): void
Parameters
- system: any
- enable: boolean = true
- force: boolean = false
Returns void
- Defined in src/interactions.ts:1470

enablePathsByType

enablePathsByType(pathTypes: string | string[], enable?: boolean): void
Parameters
- pathTypes: string | string[]
- enable: boolean = true
Returns void
- Defined in src/interactions.ts:1476

enableSckanPaths

enableSckanPaths(sckanState: string, enable?: boolean): void
Parameters
- sckanState: string
- enable: boolean = true
Returns void
- Defined in src/interactions.ts:1510

enableSystem

enableSystem(systemId: string, enable?: boolean): void
Parameters
- systemId: string
- enable: boolean = true
Returns void
- Defined in src/interactions.ts:556

excludeAnnotated

excludeAnnotated(exclude?: boolean): void
Parameters
- exclude: boolean = false
Returns void
- Defined in src/interactions.ts:1529

getFeatureState

getFeatureState(featureId: number): any
Parameters
- featureId: number
Returns any
- Defined in src/interactions.ts:604

getLayers

getLayers(): FlatMapLayer[]
Returns FlatMapLayer[]
- Defined in src/interactions.ts:532

getNerveDetails

getNerveDetails(): NerveCentrelineDetails[]
Returns NerveCentrelineDetails[]
- Defined in src/interactions.ts:1933

getState

getState(): FlatMapState
Returns FlatMapState
- Defined in src/interactions.ts:388

getSystems

getSystems(): System[]
Returns System[]
- Defined in src/interactions.ts:550

mapFeature

mapFeature(geojsonId: number): MapFeature
Parameters
- geojsonId: number
Returns MapFeature
- Defined in src/interactions.ts:579

mapFeatureFromAnnotation

mapFeatureFromAnnotation(annotation: FlatMapFeatureAnnotation): MapFeature
Parameters
- annotation: FlatMapFeatureAnnotation
Returns MapFeature
- Defined in src/interactions.ts:562

markerEvent

markerEvent(
    event: any,
    markerId: number,
    markerPosition: [number, number],
    annotation: any,
): void
Parameters
- event: any
- markerId: number
- markerPosition: [number, number]
- annotation: any
Returns void
- Defined in src/interactions.ts:1762

markerPosition

markerPosition(
annotation: FlatMapFeatureAnnotation,
options?: FlatMapMarkerOptions,
): Point2D
Parameters
- annotation: FlatMapFeatureAnnotation
- options: FlatMapMarkerOptions = {}
Returns Point2D
- Defined in src/interactions.ts:1539

nextMarkerId

nextMarkerId(): number
Returns number
- Defined in src/interactions.ts:1581

nodePathModels

nodePathModels(nodeId: number): Set<string>
Parameters
- nodeId: number
Returns Set<string>
- Defined in src/interactions.ts:1504

pathFeatureIds

pathFeatureIds(externalIds: string[]): Set<number>
Parameters
- externalIds: string[]
Returns Set<number>
- Defined in src/interactions.ts:1487

pathModelNodes

pathModelNodes(modelId: string): Set<number>
Parameters
- modelId: string
Returns Set<number>
- Defined in src/interactions.ts:1498

refreshAnnotationFeatureGeometry

refreshAnnotationFeatureGeometry(feature: AnnotatedFeature): any
Parameters
- feature: AnnotatedFeature
Returns any
- Defined in src/interactions.ts:475

removeAnnotationFeature

removeAnnotationFeature(): void
Returns void
- Defined in src/interactions.ts:459

removeCloseControl

removeCloseControl(): void
Returns void
- Defined in src/interactions.ts:379

removeDatasetMarker

removeDatasetMarker(datasetId: string): void
Parameters
- datasetId: string
Returns void
- Defined in src/interactions.ts:1705

removeImage

removeImage(mapImageId: string): void
Parameters
- mapImageId: string
Returns void
- Defined in src/interactions.ts:1916

removeMarker

removeMarker(markerId: number): void
Parameters
- markerId: number
Returns void
- Defined in src/interactions.ts:1676

removePopup

removePopup(): void
Remove the currently active popup from the map.

Returns void
- Defined in src/interactions.ts:1023

reset

reset(): void
Returns void
- Defined in src/interactions.ts:849

rollbackAnnotationEvent

rollbackAnnotationEvent(event: AnnotationEvent): void
Parameters
- event: AnnotationEvent
Returns void
- Defined in src/interactions.ts:443

selectFeature

selectFeature(featureId: number, dim?: boolean): boolean
Parameters
- featureId: number
- dim: boolean = true
Returns boolean
- Defined in src/interactions.ts:713

selectFeatures

selectFeatures(featureIds: number[]): void
Select features on the map.
Parameters
- featureIds: number[]
  An array of feature identifiers to highlight
Returns void
- Defined in src/interactions.ts:868

setFeatureAnnotated

setFeatureAnnotated(featureId: string): void
Parameters
- featureId: string
Returns void
- Defined in src/interactions.ts:506

setPaint

setPaint(options: any): void
Parameters
- options: any
Returns void
- Defined in src/interactions.ts:525

setState

setState(state: any): void
Parameters
- state: any
Returns void
- Defined in src/interactions.ts:401

setVisibilityFilter

setVisibilityFilter(filterSpecification?: PropertiesFilterExpression): void
Parameters
- filterSpecification: PropertiesFilterExpression = true
Returns void
- Defined in src/interactions.ts:1464

showAnnotator

showAnnotator(visible?: boolean): void
Parameters
- visible: boolean = true
Returns void
- Defined in src/interactions.ts:419

showMarkerPopup

showMarkerPopup(markerId: number, content: any, _options: any): boolean
Parameters
- markerId: number
- content: any
- _options: any
Returns boolean
- Defined in src/interactions.ts:1801

showPopup

showPopup(
    featureId: number,
    content: string,
    options?: FlatMapPopUpOptions,
): void
Parameters
- featureId: number
- content: string
- options: FlatMapPopUpOptions = {}
Returns void
- Defined in src/interactions.ts:935

showSearchResults

showSearchResults(featureIds: number[]): void
Parameters
- featureIds: number[]
Returns void
- Defined in src/interactions.ts:888

unselectFeature

unselectFeature(featureId: number): void
Parameters
- featureId: number
Returns void
- Defined in src/interactions.ts:748

unselectFeatures

unselectFeatures(): void
Returns void
- Defined in src/interactions.ts:769

visibleMarkerAnatomicalIds

visibleMarkerAnatomicalIds(): string[]
Returns string[]
- Defined in src/interactions.ts:1713

zoomToFeatures

zoomToFeatures(featureIds: number[], options: FeatureZoomOptions): void
Parameters
- featureIds: number[]
- options: FeatureZoomOptions
Returns void
- Defined in src/interactions.ts:895