Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrTimeAxisLabelFormat

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 format(): string
  • The DateTime format string to apply. Some common DateTime format strings are: yyyy, MM/dd/yy, and hh:mm:ss.

    The Format property provide the DateTime format string to apply.

    let labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "hh:mm:ss";
    labelFormat.range = 1000;
    this.xAxis.labelFormats.add(labelFormat);
    labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "hh:mm";
    labelFormat.range = 60 * 1000;
    this.xAxis.labelFormats.add(labelFormat);
    labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "MMM-dd-yy";
    labelFormat.range = 24 * 60 * 60 * 1000;
    this.xAxis.labelFormats.add(labelFormat);
      <IgrDataChart
    dataSource={this.state.dataSource}
    width="700px"
    height="500px">
    <IgrTimeXAxis name="xAxis" label="Date"
    dateTimeMemberPath="Date" />
    </IgrDataChart>

    Returns string

  • set format(v): void
  • Parameters

    • v: string

    Returns void

  • get i(): TimeAxisLabelFormat
  • Returns TimeAxisLabelFormat

  • get range(): number
  • The visible axis range at which to apply this label format.

    The Range property provide the visible axis range at which to apply this label format.

    let labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "hh:mm:ss";
    labelFormat.range = 1000;
    this.xAxis.labelFormats.add(labelFormat);
    labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "hh:mm";
    labelFormat.range = 60 * 1000;
    this.xAxis.labelFormats.add(labelFormat);
    labelFormat = new TimeAxisLabelFormat();
    labelFormat.format = "MMM-dd-yy";
    labelFormat.range = 24 * 60 * 60 * 1000;
    this.xAxis.labelFormats.add(labelFormat);

    Returns number

  • set range(v): void
  • Parameters

    • v: number

    Returns void

  • get repeatedDayFormat(): string
  • The DateTime format string to apply, if the day is repeated from the prior date. Some common DateTime format strings are: yyyy, MM/dd/yy, and hh:mm:ss.

    Returns string

  • set repeatedDayFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get repeatedMonthFormat(): string
  • The DateTime format string to apply, if the month is repeated from the prior date. Some common DateTime format strings are: yyyy, MM/dd/yy, and hh:mm:ss.

    Returns string

  • set repeatedMonthFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get repeatedYearFormat(): string
  • The DateTime format string to apply, if the year is repeated from the prior date. Some common DateTime format strings are: yyyy, MM/dd/yy, and hh:mm:ss.

    Returns string

  • set repeatedYearFormat(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