Class RcsbFvUI

Hierarchy

Component<RcsbFvUIConfigInterface, RcsbFvUIStateInterface>
- RcsbFvUI

Index

Constructors

Properties

config hideTask refDiv state subscription tooltipDiv ICON_PROPS

Methods

boardHover buildButton changeState componentDidMount componentWillUnmount displayUI hideUI move render setDomain setScale subscribe zoomIn zoomOut

Constructors

constructor

new RcsbFvUI(props): RcsbFvUI
Parameters
- props: RcsbFvUIConfigInterface | Readonly<RcsbFvUIConfigInterface>
Returns RcsbFvUI
Inherited from React.Component<RcsbFvUIConfigInterface, RcsbFvUIStateInterface>.constructor
- Defined in node_modules/@types/react/index.d.ts:519
new RcsbFvUI(props, context): RcsbFvUI
Parameters
- props: RcsbFvUIConfigInterface
- context: any
Returns RcsbFvUI
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
Inherited from React.Component<RcsbFvUIConfigInterface, RcsbFvUIStateInterface>.constructor
- Defined in node_modules/@types/react/index.d.ts:524

Properties

`Private` `Readonly` config

config: RcsbFvUIButtonInterface[] = ...

UI config Object

`Private` hideTask

hideTask: null | Subscription = null

`Private` refDiv

refDiv: HTMLDivElement

`Readonly` state

state: RcsbFvUIStateInterface = ...

`Private` subscription

subscription: Subscription

`Private` tooltipDiv

tooltipDiv: HTMLDivElement

`Static` `Private` `Readonly` ICON_PROPS

ICON_PROPS: {
    height: number;
    viewBox: string;
    width: number;
} = ...

Type declaration

height: number
viewBox: string
width: number

Methods

`Private` boardHover

boardHover(flag): void
Parameters
- flag: boolean
Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:138

buildButton

buildButton(buttonConfig): ReactNode
Parameters
- buttonConfig: RcsbFvUIButtonInterface
Returns ReactNode
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:184

`Private` changeState

changeState(state): void
Parameters
- state: RcsbFvUIStateInterface
Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:194

componentDidMount

componentDidMount(): void
Returns void
Overrides React.Component.componentDidMount
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:112

componentWillUnmount

componentWillUnmount(): void
Returns void
Overrides React.Component.componentWillUnmount
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:124

`Private` displayUI

displayUI(): void
Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:146

`Private` hideUI

hideUI(): void
Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:174

`Private` move

move(direction): void
Parameters
- direction: 1 | -1
Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:231

render

render(): ReactNode
Returns ReactNode
Overrides React.Component.render
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:77

`Private` setDomain

setDomain(domainData): void
Update d3 xScale domain
Parameters
- domainData: DomainViewInterface
  new xScale domain
Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:265

`Private` setScale

setScale(): void
Force all board track annotation cells to set xScale. Called when a new track has been added

Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:253

`Private` subscribe

subscribe(): Subscription
Returns Subscription
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:128

`Private` zoomIn

zoomIn(): void
- UI methods **
Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:202

`Private` zoomOut

zoomOut(): void
Returns void
- Defined in src/RcsbFv/RcsbFvUI/RcsbFvUI.tsx:215

Class RcsbFvUI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: RcsbFvUIConfigInterface | Readonly<RcsbFvUIConfigInterface>

Returns RcsbFvUI

Parameters

props: RcsbFvUIConfigInterface

context: any

Returns RcsbFvUI

Deprecated

See

Properties

Private Readonly config

Private hideTask

Private refDiv

Readonly state

Private subscription

Private tooltipDiv

Static Private Readonly ICON_PROPS

Type declaration

height: number

viewBox: string

width: number

Methods

Private boardHover

Parameters

flag: boolean

Returns void

buildButton

Parameters

buttonConfig: RcsbFvUIButtonInterface

Returns ReactNode

Private changeState

Parameters

state: RcsbFvUIStateInterface

Returns void

componentDidMount

Returns void

componentWillUnmount

Returns void

Private displayUI

Returns void

Private hideUI

Returns void

Private move

Parameters

direction: 1 | -1

Returns void

render

Returns ReactNode

Private setDomain

Parameters

domainData: DomainViewInterface

Returns void

Private setScale

Returns void

Private subscribe

Returns Subscription

Private zoomIn

Returns void

Private zoomOut

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` config

`Private` hideTask

`Private` refDiv

`Readonly` state

`Private` subscription

`Private` tooltipDiv

`Static` `Private` `Readonly` ICON_PROPS

`Private` boardHover

`Private` changeState

`Private` displayUI

`Private` hideUI

`Private` move

`Private` setDomain

`Private` setScale

`Private` subscribe

`Private` zoomIn

`Private` zoomOut