Highcharts Dashboards
    Preparing search index...

    Interface Options

    interface Options {
        caption?: TextOptionsType;
        className?: string;
        connector?: ConnectorOptions;
        editableOptions?: Options[];
        elements?: Node[];
        events?: Record<string, Function>;
        html?: string;
        id?: string;
        renderTo?: string;
        states?: StatesOptions;
        sync?: RawOptionsRecord;
        title?: TextOptionsType;
        type: "HTML";
    }

    Hierarchy (View Summary)

    Index

    Properties

    caption? className? connector? editableOptions? elements? events? html? id? renderTo? states? sync? title? type

    Properties

    caption?: TextOptionsType

    The component's caption, which will render at the bottom.

    Try it:

    Changed captions

    className?: string

    The name of class that is applied to the component's container.

    connector?: ConnectorOptions

    Connector options

    editableOptions?: Options[]

    Set of options that are available for editing through sidebar.

    elements?: Node[]

    Array of HTML elements, declared as string or node.

    Example:

    elements: [{
      tagName: 'img',
      attributes: {
          src: 'http://path.to.image'
      }
    }]

    Try it:

    HTML component with one image.

    HTML component with nested images.

    events?: Record<string, Function>

    Events attached to the component : mount, unmount, resize, update.

    Try it:

    Mount event

    html?: string

    The HTML content of the component. If the elements option is set, the html option will be ignored.

    html: `
         <div>
             <h1>Custom HTML</h1>
             <span id="custom-html-div">Custom HTML added as string</span>
         </div>
    `
    id?: string

    Sets an ID for the component's container.

    renderTo?: string

    Cell id, where component is attached.

    states?: StatesOptions

    States for the component.

    sync?: RawOptionsRecord

    Sync options. Predefined per component or custom sync options can be used here.

    title?: TextOptionsType

    The component's title, which will render at the top.

    Try it:

    Changed captions

    type: "HTML"

    The type of component like: HTML, KPI, Highcharts, Grid, Navigator.

    Settings

    On This Page

    Properties