Hierarchy

Hierarchy

Constructors

Properties

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>
props: Readonly<IIgrContentPaneProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
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}</>;
}
}

Accessors

  • get acceptsInnerDock(): boolean
  • Determines whether the end user can inner dock another pane in this one. Defaults to true.

    Returns boolean

  • set acceptsInnerDock(v): void
  • Parameters

    • v: boolean

    Returns void

  • get allowClose(): boolean
  • Determines whether the end user is allowed to close the pane. Defaults to true.

    Returns boolean

  • set allowClose(v): void
  • Parameters

    • v: boolean

    Returns void

  • get allowDocking(): boolean
  • Determines whether the end user is allowed to dock the pane. Defaults to true.

    Returns boolean

  • set allowDocking(v): void
  • Parameters

    • v: boolean

    Returns void

  • get allowFloating(): boolean
  • Determines whether the end user is allowed to make the pane floating. Defaults to true.

    Returns boolean

  • set allowFloating(v): void
  • Parameters

    • v: boolean

    Returns void

  • get allowMaximize(): boolean
  • Determines whether the end user is allowed to maximize the pane.

    Returns boolean

  • set allowMaximize(v): void
  • Parameters

    • v: boolean

    Returns void

  • get allowPinning(): boolean
  • Determines whether the end user is allowed to pin/unpin the pane. Defaults to true.

    Returns boolean

  • set allowPinning(v): void
  • Parameters

    • v: boolean

    Returns void

  • get contentId(): string
  • The slot attribute's value of the content element.

    Returns string

  • set contentId(v): void
  • Parameters

    • v: string

    Returns void

  • get disabled(): boolean
  • Determines whether a pane is disabled. Defaults to false.

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get documentOnly(): boolean
  • Marks that a content pane can be docked only inside a document host.

    Returns boolean

  • set documentOnly(v): void
  • Parameters

    • v: boolean

    Returns void

  • get floatingHeaderId(): string
  • The slot attribute's value of the floating header element. If not set, the headerId property value is used.

    Returns string

  • set floatingHeaderId(v): void
  • Parameters

    • v: string

    Returns void

  • get header(): string
  • The text header of the content pane. Even if header slot templates are used, the text header is used for aria label.

    Returns string

  • set header(v): void
  • Parameters

    • v: string

    Returns void

  • get headerId(): string
  • The slot attribute's value of the content pane header element. If not set, the header property value is used.

    Returns string

  • set headerId(v): void
  • Parameters

    • v: string

    Returns void

  • get hidden(): boolean
  • Determines whether a pane is hidden in the UI. Defaults to false.

    Returns boolean

  • set hidden(v): void
  • Parameters

    • v: boolean

    Returns void

  • get id(): string
  • The id of the pane. If not set the Dock Manager generates it automatically.

    Returns string

  • set id(v): void
  • Parameters

    • v: string

    Returns void

  • get isMaximized(): boolean
  • Determines whether a content pane is maximized or not. Defaults to false.

    Returns boolean

  • set isMaximized(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isPinned(): boolean
  • Determines whether a content pane is pinned or not. Defaults to true.

    Returns boolean

  • set isPinned(v): void
  • Parameters

    • v: boolean

    Returns void

  • get name(): string
  • Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get size(): number
  • The size of the pane relative to its sibling panes' sizes. Defaults to 100.

    Returns number

  • set size(v): void
  • Parameters

    • v: number

    Returns void

  • get tabHeaderId(): string
  • The slot attribute's value of the tab header element. If not set, the header property value is used.

    Returns string

  • set tabHeaderId(v): void
  • Parameters

    • v: string

    Returns void

  • get unpinnedHeaderId(): string
  • The slot attribute's value of the unpinned header element. If not set, the header property value is used.

    Returns string

  • set unpinnedHeaderId(v): void
  • Parameters

    • v: string

    Returns void

  • get unpinnedLocation(): UnpinnedLocation
  • The desired unpinned location of the content pane. If not set the Dock Manager automatically calculates it based on the location of the pane relatively to the document host. If more than one document host is presented, the closest one in the pane hierarchy will be used for the calculation. If there is no document host, the default location is left.

    Returns UnpinnedLocation

  • set unpinnedLocation(v): void
  • Parameters

    Returns void

  • get unpinnedSize(): number
  • The absolute size of the pane in an unpinned state. Defaults to 200.

    Returns number

  • set unpinnedSize(v): void
  • Parameters

    • v: number

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • 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

    Returns 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

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • 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 any

  • Returns DOMElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
        style: {};
    }, any>

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean