Represents a style to apply to a treemap node.

Type Parameters

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<P> & 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 fadeOpacity(): number
  • Gets or sets the fade opacity that should be used when highlighting.

    Returns number

  • set fadeOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get fill(): string
  • Gets or sets the fill color to use for the nodes.

    Returns string

  • set fill(v): void
  • Parameters

    • v: string

    Returns void

  • get headerBackground(): string
  • Gets or sets the background to use for the header.

    Returns string

  • set headerBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get headerHeight(): number
  • Gets or sets the height to use for the header.

    Returns number

  • set headerHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get headerHoverBackground(): string
  • Gets or sets the background to use for the header when it is hovered.

    Returns string

  • set headerHoverBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get headerHoverTextColor(): string
  • Gets or sets the text color to use for the header.

    Returns string

  • set headerHoverTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get headerLabelBottomMargin(): number
  • Gets or sets the bottom margin to use for the labels.

    Returns number

  • set headerLabelBottomMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get headerLabelLeftMargin(): number
  • Gets or sets the left margin to use for the header.

    Returns number

  • set headerLabelLeftMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get headerLabelRightMargin(): number
  • Gets or sets the right margin to use for the header.

    Returns number

  • set headerLabelRightMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get headerLabelTopMargin(): number
  • Gets or sets the top margin to use for the header.

    Returns number

  • set headerLabelTopMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get headerTextColor(): string
  • Gets or sets the text color to use for the header.

    Returns string

  • set headerTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get highlightingHandled(): boolean
  • Gets or sets if highlighting was handled, and whether internal highlighting logic should be skipped.

    Returns boolean

  • set highlightingHandled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get label(): string
  • Gets or sets the label to use for the node.

    Returns string

  • set label(v): void
  • Parameters

    • v: string

    Returns void

  • get labelBottomMargin(): number
  • Gets or sets the bottom margin to use for the labels.

    Returns number

  • set labelBottomMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get labelHorizontalAlignment(): HorizontalAlignment
  • Gets or sets the horizontal alignment to use for the node labels.

    Returns HorizontalAlignment

  • set labelHorizontalAlignment(v): void
  • Parameters

    • v: HorizontalAlignment

    Returns void

  • get labelLeftMargin(): number
  • Gets or sets the left margin to use for the labels.

    Returns number

  • set labelLeftMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get labelRightMargin(): number
  • Gets or sets the right margin to use for the labels.

    Returns number

  • set labelRightMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get labelTopMargin(): number
  • Gets or sets the top margin to use for the labels.

    Returns number

  • set labelTopMargin(v): void
  • Parameters

    • v: number

    Returns void

  • get labelVerticalAlignment(): VerticalAlignment
  • Gets or sets the vertical alignment to use for the node labels.

    Returns VerticalAlignment

  • set labelVerticalAlignment(v): void
  • Parameters

    • v: VerticalAlignment

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get opacity(): number
  • Gets or sets the opacity to use for the node.

    Returns number

  • set opacity(v): void
  • Parameters

    • v: number

    Returns void

  • get outline(): string
  • Gets or sets the outline to use for the nodes.

    Returns string

  • set outline(v): void
  • Parameters

    • v: string

    Returns void

  • get strokeThickness(): number
  • Gets or sets the stroke thickness to use for the node outline.

    Returns number

  • set strokeThickness(v): void
  • Parameters

    • v: number

    Returns void

  • get textColor(): string
  • Gets or sets the text color to use for the nodes.

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    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

  • 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

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    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

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>

    Returns any

  • Returns any

  • 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