Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UMAPVisualization<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

props

props: Readonly<IUMAPVisualizationProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<IUMAPVisualizationState>

Private timeout1

timeout1: number | undefined

Private timeout2

timeout2: number | undefined

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

Private executeUMAP

  • executeUMAP(): void

forceUpdate

  • forceUpdate(callback?: undefined | function): void
  • Parameters

    • Optional callback: undefined | function

    Returns void

Protected get3DMenuItems

Protected getData

  • getData(umapEmbedding: number[][], dataLabels?: Array<ILabel | undefined>, tooltipNames?: string[]): IPlotlyData[]

Protected getData2D

  • getData2D(umapEmbedding: number[][], dataLabels?: Array<ILabel | undefined>, tooltipNames?: string[]): object
  • Get data for a 2D UMAP Visualization in the proper format for Plotly.

    Parameters

    • umapEmbedding: number[][]
    • Default value dataLabels: Array<ILabel | undefined> = []
    • Default value tooltipNames: string[] = []

    Returns object

Protected getData3D

  • getData3D(umapEmbedding: number[][], dataLabels?: Array<ILabel | undefined>, tooltipNames?: string[]): object
  • Get data for a 2D UMAP Visualization in the proper format for Plotly.

    Parameters

    • umapEmbedding: number[][]
    • Default value dataLabels: Array<ILabel | undefined> = []
    • Default value tooltipNames: string[] = []

    Returns object

Protected getLegendStats

  • getLegendStats(): object

Protected getMenuItems

Protected getSettingsConfigs

  • getSettingsConfigs(): object

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

Protected handlePointSelection

Protected onDimensionChange

  • onDimensionChange(value: number): void

Protected onLabelChange

  • onLabelChange(event: SyntheticEvent, data: DropdownProps): void

Private onLegendClick

Protected onMinDistChange

  • onMinDistChange(value: number): void

Protected onNumNeighborsChange

  • onNumNeighborsChange(value: number): void

Protected onOrbitClick

  • onOrbitClick(): void

Protected onPanClick

  • onPanClick(): void

Protected onSpreadChange

  • onSpreadChange(value: number): void

Protected onTurntableClick

  • onTurntableClick(): void

Protected onZoomClick

  • onZoomClick(): void

render

  • render(): Element

Protected render2D

  • render2D(showLegend: boolean, plotlyData: IPlotlyData[]): Element

Protected render3D

  • render3D(showLegend: boolean, plotlyData: IPlotlyData[]): Element

Protected renderCategoryDropdown

  • renderCategoryDropdown(): false | Element

setState

  • setState<K>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof IUMAPVisualizationState

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

Object literals

Static defaultProps

defaultProps: object

currentCells

currentCells: Set<number> = Set<number>()

currentLabel

currentLabel: string = ""

distanceFn

distanceFn: euclidean = euclidean

errorMessages

errorMessages: never[] = []

labels

labels: never[] = []

minDist

minDist: number = 0.99

nComponents

nComponents: 2 | 3 = 2 as 2 | 3

nNeighbors

nNeighbors: number = 15

numIterationsBeforeReRender

numIterationsBeforeReRender: number = 1

onLabelChange

onLabelChange: EMPTY_FUNCTION = EMPTY_FUNCTION

setCurrentCells

setCurrentCells: EMPTY_FUNCTION = EMPTY_FUNCTION

spread

spread: number = 1

Static initialState

initialState: object

currentEpoch

currentEpoch: undefined | number = undefined as number | undefined

dataVisibility

dataVisibility: object = {} as Record<number, boolean>

Type declaration

dragMode

dragMode: "zoom" | "pan" | "orbit" | "turntable" = 'turntable' as 'orbit' | 'pan' | 'turntable' | 'zoom'

numDimensions

numDimensions: 2 | 3 = UMAPVisualization.defaultProps.nComponents

numMinDist

numMinDist: number = UMAPVisualization.defaultProps.minDist

numNeighbors

numNeighbors: number = UMAPVisualization.defaultProps.nNeighbors

numSpread

numSpread: number = UMAPVisualization.defaultProps.spread

plotlyData

plotlyData: IPlotlyData[] = new Array<IPlotlyData>()

totalNumberEpochs

totalNumberEpochs: undefined | number = undefined as number | undefined

umapEmbedding

umapEmbedding: number[][] = new Array(new Array<number>())

ranges

ranges: object

maxX

maxX: number = -20

maxY

maxY: number = -20

maxZ

maxZ: number = -20

minX

minX: number = 20

minY

minY: number = 20

minZ

minZ: number = 20

Generated using TypeDoc