Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContactMapComponent<SS>

Presentational Component for the ContactMap.

extends

{React.Component<IContactMapComponentProps, ContactMapComponentState>}

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<IContactMapComponentProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: ContactMapComponentState = initialContactMapState

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

Protected applySavedNodeOptions

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

forceUpdate

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

    • Optional callback: undefined | function

    Returns void

Protected generateHoveredResiduePairs

  • generateHoveredResiduePairs(hoveredResidues: RESIDUE_TYPE[]): object[]

Protected generateLockedResiduePairs

Protected generateSelectedResiduesChartData

Protected getColorFromEntry

  • getColorFromEntry(entry: IContactMapChartData): undefined | null | string | number | (undefined | null | string | number)[] | (undefined | null | string | number)[][]
  • Gets the color from the provided chart entry.

    The following are checked in order - the first one found is the color returned:

    • Marker's line color.
    • Marker's color.
    • Marker's colorscale.
    • Line color.

    Parameters

    Returns undefined | null | string | number | (undefined | null | string | number)[] | (undefined | null | string | number)[][]

Protected getDockConfigs

  • getDockConfigs(): object[]

Protected getMenuConfigs

Protected getNodeOptionConfigs

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 handleAxisClick

Protected handleAxisEnter

Protected handleAxisLeave

Protected onMouseClick

  • onMouseClick(cb: function): (Anonymous function)

Protected onMouseEnter

  • onMouseEnter(cb: function): (Anonymous function)

Protected onMouseLeave

  • onMouseLeave(cb?: undefined | function): (Anonymous function)

Protected onMouseSelect

  • onMouseSelect(cb?: undefined | function): (Anonymous function)

onNodeSelectionChange

  • onNodeSelectionChange(index: number): (Anonymous function)

onNodeSizeChange

  • onNodeSizeChange(index: number, nodeSizeMod: number): (Anonymous function)

render

  • render(): Element

Protected renderContactMapChart

setState

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

    • K: keyof ContactMapComponentState

    Parameters

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

    Returns void

Protected setupPointsToPlot

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

addHoveredResidues

addHoveredResidues: EMPTY_FUNCTION = EMPTY_FUNCTION

addHoveredSecondaryStructure

addHoveredSecondaryStructure: EMPTY_FUNCTION = EMPTY_FUNCTION

addSelectedSecondaryStructure

addSelectedSecondaryStructure: EMPTY_FUNCTION = EMPTY_FUNCTION

configurations

enableSliders

enableSliders: boolean = true

formattedPoints

formattedPoints: IContactMapChartData[] = new Array<IContactMapChartData>()

height

height: string = "100%"

highlightColor

highlightColor: string = "#ff8800"

hoveredResidues

hoveredResidues: never[] = []

hoveredSecondaryStructures

hoveredSecondaryStructures: never[] = []

isDataLoading

isDataLoading: boolean = false

lockedResiduePairs

lockedResiduePairs: object

Type declaration

observedColor

observedColor: string = "#0000ff"

removeAllLockedResiduePairs

removeAllLockedResiduePairs: EMPTY_FUNCTION = EMPTY_FUNCTION

removeAllSelectedSecondaryStructures

removeAllSelectedSecondaryStructures: EMPTY_FUNCTION = EMPTY_FUNCTION

removeHoveredResidues

removeHoveredResidues: EMPTY_FUNCTION = EMPTY_FUNCTION

removeHoveredSecondaryStructure

removeHoveredSecondaryStructure: EMPTY_FUNCTION = EMPTY_FUNCTION

removeSecondaryStructure

removeSecondaryStructure: EMPTY_FUNCTION = EMPTY_FUNCTION

selectedSecondaryStructures

selectedSecondaryStructures: never[] = []

showConfigurations

showConfigurations: boolean = true

toggleLockedResiduePair

toggleLockedResiduePair: EMPTY_FUNCTION = EMPTY_FUNCTION

width

width: string = "100%"

data

data: object

couplingScores

couplingScores: CouplingContainer = new CouplingContainer()

secondaryStructures

secondaryStructures: Bioblocks1DSection<"C" | "E" | "G" | "H" | "I" | "S" | "T" | "B">[][] = new Array<SECONDARY_STRUCTURE>()

pdbData

pdbData: object

experimental

experimental: undefined = undefined

predicted

predicted: undefined = undefined

Generated using TypeDoc