Class Explorer_Class

Hierarchy

Component<Props, State>
- Explorer_Class

Index

Constructors

constructor

Properties

Constructors

constructor

new Explorer_Class(props: Props): Explorer_Class

Overrides base.react.Component<Props, State>.constructor
- Defined in sanddance-explorer/src/explorer.tsx:1578
Parameters
- props: Props
Returns Explorer_Class

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://react.dev/reference/react/Component#context

dialogFocusHandler

dialogFocusHandler: { focus?: any }

Type declaration

focus: function
- focus(): void
- - Defined in sanddance-explorer/src/explorer.tsx:1570
  Returns void

discardColorContextUpdates

discardColorContextUpdates: boolean

div

div: HTMLElement

imageHolder

imageHolder: ImageHolder

prefs

prefs: Prefs

Readonly props

props: Readonly<Props> & Readonly<{ children?: ReactNode }>

refs

refs: {}

deprecated: https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration

[key: string]: ReactInstance

snapshotThumbWidth

snapshotThumbWidth: number

state

state: Readonly<State>

viewer

viewer: Viewer

viewerOptions

viewerOptions: Partial<ViewerOptions>

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://react.dev/reference/react/Component#static-contexttype

Methods

Optional UNSAFE_componentWillMount

UNSAFE_componentWillMount(): void

Inherited from base.react.Component.UNSAFE_componentWillMount
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:742
Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use componentDidMount or the constructor instead

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns void

Optional UNSAFE_componentWillReceiveProps

UNSAFE_componentWillReceiveProps(nextProps: Readonly<Props>, nextContext: any): void

Inherited from base.react.Component.UNSAFE_componentWillReceiveProps
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:774
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use static getDerivedStateFromProps instead

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<Props>
- nextContext: any
Returns void

Optional UNSAFE_componentWillUpdate

UNSAFE_componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, nextContext: any): void

Inherited from base.react.Component.UNSAFE_componentWillUpdate
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:802
Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use getSnapshotBeforeUpdate instead

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<Props>
- nextState: Readonly<State>
- nextContext: any
Returns void

addHistory

addHistory(historicInsight: Partial<HistoricInsight>, historyAction: HistoryAction, additionalUIState?: Partial<UIState>): void

- Defined in sanddance-explorer/src/explorer.tsx:1594
Parameters
- historicInsight: Partial<HistoricInsight>
- historyAction: HistoryAction
- Optional additionalUIState: Partial<UIState>
Returns void

calculate

calculate(calculating: () => any): void

- Defined in sanddance-explorer/src/explorer.tsx:1591
Parameters
- calculating: () => any
  - - (): any
    - Returns any
Returns void

changeChartType

changeChartType(chart: Chart): InsightColumns

- Defined in sanddance-explorer/src/explorer.tsx:1590
Parameters
- chart: Chart
Returns InsightColumns

changeColumnMapping

changeColumnMapping(role: InsightColumnRoles, column: Column, options?: ChangeColumnMappingOptions): void

- Defined in sanddance-explorer/src/explorer.tsx:1599
Parameters
- role: InsightColumnRoles
- column: Column
- Optional options: ChangeColumnMappingOptions
Returns void

changeView

changeView(view: View): void

- Defined in sanddance-explorer/src/explorer.tsx:1592
Parameters
- view: View
Returns void

changespecCapabilities

changespecCapabilities(specCapabilities: SpecCapabilities): void

- Defined in sanddance-explorer/src/explorer.tsx:1598
Parameters
- specCapabilities: SpecCapabilities
Returns void

Optional componentDidCatch

componentDidCatch(error: Error, errorInfo: ErrorInfo): void

Inherited from base.react.Component.componentDidCatch
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:671
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

Overrides base.react.Component.componentDidMount
- Defined in sanddance-explorer/src/explorer.tsx:1616
Returns void

Optional componentDidUpdate

componentDidUpdate(prevProps: Readonly<Props>, prevState: Readonly<State>, snapshot?: any): void

Inherited from base.react.Component.componentDidUpdate
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:713
Called immediately after updating occurs. Not called for the initial render.

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

Parameters
- prevProps: Readonly<Props>
- prevState: Readonly<State>
- Optional snapshot: any
Returns void

Optional componentWillMount

componentWillMount(): void

Inherited from base.react.Component.componentWillMount
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:728
Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use componentDidMount or the constructor instead; will stop working in React 17

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns void

Optional componentWillReceiveProps

componentWillReceiveProps(nextProps: Readonly<Props>, nextContext: any): void

Inherited from base.react.Component.componentWillReceiveProps
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:757
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<Props>
- nextContext: any
Returns void

Optional componentWillUnmount

componentWillUnmount(): void

Inherited from base.react.Component.componentWillUnmount
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:666
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

componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, nextContext: any): void

Inherited from base.react.Component.componentWillUpdate
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:787
Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see

https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<Props>
- nextState: Readonly<State>
- nextContext: any
Returns void

finalize

finalize(): void

- Defined in sanddance-explorer/src/explorer.tsx:1579
Returns void

forceUpdate

forceUpdate(callback?: () => void): void

Inherited from base.react.Component.forceUpdate
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:521
Parameters
- Optional callback: () => void
  - - (): void
    - Returns void
Returns void

getInsight

getInsight(): Insight

- Defined in sanddance-explorer/src/explorer.tsx:1583
Returns Insight

getSetup

getSetup(): Setup

- Defined in sanddance-explorer/src/explorer.tsx:1584
Returns Setup

Optional getSnapshotBeforeUpdate

getSnapshotBeforeUpdate(prevProps: Readonly<Props>, prevState: Readonly<State>): any

Inherited from base.react.Component.getSnapshotBeforeUpdate
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:707
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
- prevProps: Readonly<Props>
- prevState: Readonly<State>
Returns any

load

load(data: object[] | DataFile, getPartialInsight?: (columns: Column[]) => Partial<Insight>, optionsOrPrefs?: Prefs | Options): Promise<void>

- Defined in sanddance-explorer/src/explorer.tsx:1589
Parameters
- data: object[] | DataFile
- Optional getPartialInsight: (columns: Column[]) => Partial<Insight>
  - - (columns: Column[]): Partial<Insight>
    - Parameters
      - columns: Column[]
      Returns Partial<Insight>
- Optional optionsOrPrefs: Prefs | Options
Returns Promise<void>

redo

redo(historyIndex?: number): void

- Defined in sanddance-explorer/src/explorer.tsx:1597
Parameters
- Optional historyIndex: number
Returns void

render

render(): Element

Overrides base.react.Component.render
- Defined in sanddance-explorer/src/explorer.tsx:1617
Returns Element

resize

resize(): void

- Defined in sanddance-explorer/src/explorer.tsx:1605
Returns void

reviveSnapshot

reviveSnapshot(snapshotOrIndex: number | Snapshot): void

- Defined in sanddance-explorer/src/explorer.tsx:1588
Parameters
- snapshotOrIndex: number | Snapshot
Returns void

scrollSnapshotIntoView

scrollSnapshotIntoView(selectedSnapshotIndex: number): void

- Defined in sanddance-explorer/src/explorer.tsx:1615
Parameters
- selectedSnapshotIndex: number
Returns void

setInsight

setInsight(historyAction: HistoryAction, newState: Partial<UIState>, partialInsight: Partial<Insight>, rebaseFilter: boolean, setup?: Setup): void

- Defined in sanddance-explorer/src/explorer.tsx:1586
Parameters
- historyAction: HistoryAction
- newState: Partial<UIState>
- partialInsight: Partial<Insight>
- rebaseFilter: boolean
- Optional setup: Setup
Returns void

setState

setState<K>(state: State | ((prevState: Readonly<State>, props: Readonly<Props>) => State | Pick<State, K>) | Pick<State, K>, callback?: () => void): void

Inherited from base.react.Component.setState
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:516
Type parameters
- K: keyof State
Parameters
- state: State | ((prevState: Readonly<State>, props: Readonly<Props>) => State | Pick<State, K>) | Pick<State, K>
- Optional callback: () => void
  - - (): void
    - Returns void
Returns void

Optional shouldComponentUpdate

shouldComponentUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, nextContext: any): boolean

Inherited from base.react.Component.shouldComponentUpdate
- Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:661
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
- nextProps: Readonly<Props>
- nextState: Readonly<State>
- nextContext: any
Returns boolean

sidebar

sidebar(sidebarClosed: boolean, sidebarPinned: boolean): void

- Defined in sanddance-explorer/src/explorer.tsx:1604
Parameters
- sidebarClosed: boolean
- sidebarPinned: boolean
Returns void

signal

signal(signalName: string, signalValue: any, newViewStateTarget?: boolean): void

- Defined in sanddance-explorer/src/explorer.tsx:1581
Parameters
- signalName: string
- signalValue: any
- Optional newViewStateTarget: boolean
Returns void

undo

undo(): void

- Defined in sanddance-explorer/src/explorer.tsx:1596
Returns void

updateViewerOptions

updateViewerOptions(viewerOptions: Partial<ViewerOptions>): void

- Defined in sanddance-explorer/src/explorer.tsx:1580
Parameters
- viewerOptions: Partial<ViewerOptions>
Returns void

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: Props

Returns Explorer_Class

Properties

context

dialogFocusHandler

Type declaration

focus: function

Returns void

discardColorContextUpdates

div

imageHolder

prefs

Readonly props

refs

Type declaration

[key: string]: ReactInstance

snapshotThumbWidth

state

viewer

viewerOptions

Static Optional contextType

Methods

Optional UNSAFE_componentWillMount

Returns void

Optional UNSAFE_componentWillReceiveProps

Parameters

nextProps: Readonly<Props>

nextContext: any

Returns void

Optional UNSAFE_componentWillUpdate

Parameters

nextProps: Readonly<Props>

nextState: Readonly<State>

nextContext: any

Returns void

addHistory

Parameters

historicInsight: Partial<HistoricInsight>

historyAction: HistoryAction

Optional additionalUIState: Partial<UIState>

Returns void

calculate

Parameters

calculating: () => any

Returns any

Returns void

changeChartType

Parameters

chart: Chart

Returns InsightColumns

changeColumnMapping

Parameters

role: InsightColumnRoles

column: Column

Optional options: ChangeColumnMappingOptions

Returns void

changeView

Parameters

view: View

Returns void

changespecCapabilities

Parameters

specCapabilities: SpecCapabilities

Returns void

Optional componentDidCatch

Parameters

error: Error

errorInfo: ErrorInfo

Returns void

componentDidMount

Returns void

Optional componentDidUpdate