trueChart Core API

Interface of the main trueChart class

Hierarchy

  • ITrueChart

Index

Properties

Methods

Properties

Readonly DataManager

DataManager: IDataManager

returns the DataManager instance

Readonly Element

Element: HTMLElement

element where trueChart paints into

Readonly EventsManager

EventsManager: IEventsManager

returns the EventsManager instance

Readonly FeatureManager

FeatureManager: IFeatureManager

returns the FeatureManager instance

Readonly Initialized

Initialized: Promise<void>

a Promise which will be resolved, when trueChart is completely initialized

Readonly LayoutManager

LayoutManager: ILayoutManager

returns the LayoutManager instance

PreventActions

PreventActions: boolean

If true, trueChart will prevent the action execution

Readonly TemplateManager

TemplateManager: ITemplateManager

returns the TemplateManager instance

Methods

delete

  • delete(): Promise<boolean>

  • deletes the extension before deleting it prompts the user to confirm the delete action as delete can not be undone

    Returns Promise<boolean>

    true in case the it was successful, false the user canceled the action in case of an error the the promise will be rejected

getIsActive

  • getIsActive(): boolean

  • evaluates the registered callback returns the value

    Returns boolean

    the active state

getIsHidden

  • getIsHidden(): boolean

  • evaluates the registered callback returns the value

    Returns boolean

    the active state

reinitialize

  • reinitialize(): Promise<void>

  • reinitializes the instance

    Returns Promise<void>

setIsActive

  • setIsActive(cb: boolean | function): void

  • register an callback that evaluates if on extension is active use this to 'deregister' a trueChart instance when it is not visible on the actual sheet

    Parameters

    • cb: boolean | function

      function that returns the state or boolean

    Returns void

setIsHidden

  • setIsHidden(cb: boolean | function): void

  • register an callback that evaluates if on extension is hidden tell trueChart that is located on a sheet but currently not displayed

    Parameters

    • cb: boolean | function

      function that returns the state or boolean

    Returns void

show

  • show(): void

  • shows the trueChart component

    Returns void