Class HTMLComponent

constructor

• new HTMLComponent(cell: Cell, options: Partial<Options>): HTMLComponent

  Creates a HTML component in the cell.

  Parameters

  • cell: Cell

    Instance of cell, where component is attached.

  • options: Partial<Options>

    The options for the component.

  Returns HTMLComponent

OptionalcaptionElement

connectorHandlers

Protecteddimensions

editableOptions

id

OptionalisActive

options

Protected OptionalsyncHandlers

type

StaticdefaultOptions

StaticpredefinedSyncConfig

destroy

• destroy(): void

  Destroys the component.

  Returns void

getDataTable

• getDataTable(connectorId?: string, dataTableKey?: string): DataTable | undefined

  Returns the data table connected to the component by the connectorId and dataTableKey. If both args are undefined, the first data table is returned.

  Parameters

  • OptionalconnectorId: string

    The id of the connector.

  • OptionaldataTableKey: string

    The key of the data table within the connector.

  Returns DataTable | undefined

  The data table, or undefined if no matching handler is found.

getEditableOptions

• getEditableOptions(): Options

  Retrieves editable options for the HTML component.

  Returns Options

getEditableOptionValue

• getEditableOptionValue(
      propertyPath?: string[],
  ): string | number | boolean | undefined

  Get the value of the editable option by property path. Parse the elements if the HTML options is not set.

  Parameters

  • OptionalpropertyPath: string[]

    The property path of the option.

  Returns string | number | boolean | undefined

getOptionsOnDrop

• getOptionsOnDrop(): Partial<Options>

  Returns the component's options when it is dropped from the sidebar.

  Returns Partial<Options>

initConnectors

• initConnectors(): Promise<HTMLComponent>

  Initializes connector handlers for the component.

  Returns Promise<HTMLComponent>

resize

• resize(width?: string | number | null, height?: string | number | null): this

  Resize the component

  Parameters

  • Optionalwidth: string | number | null

    The width to set the component to. Can be pixels, a percentage string or null. Null will unset the style

  • Optionalheight: string | number | null

    The height to set the component to. Can be pixels, a percentage string or null. Null will unset the style.

  Returns this

ProtectedresizeDynamicContent

• resizeDynamicContent(
      width?: string | number | null,
      height?: string | number | null,
  ): void

  It's a temporary alternative for the resize method. It sets the strict pixel height for the component so that the content can be distributed in the right way, without looping the resizers in the content and container.

  Parameters

  • Optionalwidth: string | number | null

    The width to set the component to.

  • Optionalheight: string | number | null

    The height to set the component to.

  Returns void

resizeTo

• resizeTo(element: HTMLElement): void

  Adjusts size of component to parent's cell size when animation is done.

  Parameters

  • element: HTMLElement

    HTML element that is resized.

  Returns void

setCaption

• setCaption(captionOptions: TextOptionsType): void

  Adds caption at the bottom of component's container.

  Parameters

  • captionOptions: TextOptionsType

    The options for the caption.

  Returns void

setTitle

• setTitle(titleOptions: TextOptionsType): void

  Adds title at the top of component's container.

  Parameters

  • titleOptions: TextOptionsType

    The options for the title.

  Returns void

update

• update(options: Partial<Options>, shouldRerender?: boolean): Promise<void>

  Handles updating via options.

  Parameters

  • options: Partial<Options>

    The options to apply.

  • shouldRerender: boolean = true

  Returns Promise<void>