Class UserInteractions

Index

Constructors

Accessors

minimap pathManager

Methods

abortAnnotationEvent activateFeature activateLineFeatures addAnnotationFeature addCloseControl addDatasetMarkers addImage addLayeredMarker addMarker changeAnnotationDrawMode clearAnnotationFeatures clearDatasetMarkers clearMarkers clearSearchResults clearVisibilityFilter closeMinimap commitAnnotationEvent createMinimap enableConnectivityByTaxonIds enableFeature enableFeatureResetOnClick enableFeatureWithChildren enableFlightPaths enableLayer enableMapFeature enableNeuronPathsByNerve enablePanZoomEvents enablePathsBySystem enablePathsByType enableSckanPaths enableSystem excludeAnnotated freeLayersResource 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:357

pathManager

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

Methods

abortAnnotationEvent

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

activateFeature

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

activateLineFeatures

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

addAnnotationFeature

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

addCloseControl

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

addDatasetMarkers

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

addImage

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

addLayeredMarker

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

addMarker

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

changeAnnotationDrawMode

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

clearAnnotationFeatures

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

clearDatasetMarkers

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

clearMarkers

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

clearSearchResults

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

clearVisibilityFilter

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

closeMinimap

closeMinimap(): void
Returns void
- Defined in src/interactions.ts:363

commitAnnotationEvent

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

createMinimap

createMinimap(options?: MinimapOptions): void
Parameters
- options: MinimapOptions = {}
Returns void
- Defined in src/interactions.ts:372

enableConnectivityByTaxonIds

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

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:684

enableFeatureResetOnClick

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

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:698

enableFlightPaths

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

enableLayer

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

enableMapFeature

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

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:1991

enablePanZoomEvents

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

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:1521

enablePathsByType

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

enableSckanPaths

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

enableSystem

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

excludeAnnotated

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

freeLayersResource

freeLayersResource(): void
Free up gl context used in layermanager, only call this when the GL context is lost

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

getFeatureState

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

getLayers

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

getNerveDetails

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

getState

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

getSystems

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

mapFeature

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

mapFeatureFromAnnotation

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

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:1814

markerPosition

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

nextMarkerId

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

nodePathModels

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

pathFeatureIds

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

pathModelNodes

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

refreshAnnotationFeatureGeometry

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

removeAnnotationFeature

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

removeCloseControl

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

removeDatasetMarker

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

removeImage

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

removeMarker

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

removePopup

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

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

reset

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

rollbackAnnotationEvent

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

selectFeature

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

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:903

setFeatureAnnotated

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

setPaint

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

setState

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

setVisibilityFilter

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

showAnnotator

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

showMarkerPopup

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

showPopup

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

showSearchResults

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

unselectFeature

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

unselectFeatures

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

visibleMarkerAnatomicalIds

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

zoomToFeatures

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