ActiveUI

ActiveUI

  • User Guide
  • Developer Documentation

Home > @activeviam/activeui-sdk > ContainerApi

ContainerApi interface

Signature:

export interface ContainerApi 

Methods

MethodDescription
canBeSavedAsBookmark()
deselect()Enables you to deselect an already selected container. If applied to a non selected container, it won't have any effect.
getBookmark()
getBookmarkContainerKey()
getBookmarkContentServerUrl()
getBookmarkId()
getBookmarkMenuPosition()
getBookmarkName()
getBookmarkPath()
getBookmarkPathCaption()
getBookmarkShowTitleBar()
getBookmarkStyle()
getContainer()
getInitialBookmarkValue()
getRoots()
getTitleBarActions()
hasUnsavedChanges()
isBookmarkWritable()
isFullSize()
isLoaded()
isNameValid()
loadBookmark(bookmark)
saveBookmark()
select()Enables you to select core data visualization containers. That includes: core standalone widgets, core widgets inside a dashboard and core widgets inside a custom container. It won't have any effect if applied to dashboards, custom containers or helper containers (e.g. a content editor). If applied to an already selected container, the container will remain selected.
setBookmarkName(name)
setBookmarkShowTitleBar(showTitleBar)
setBookmarkStyle(style)
setFullSize(fullSize)
unloadBookmark()
waitForBookmarkToHaveLoaded()
  • ContainerApi interface
  • Methods
Copyright © 2023 ActiveViam