API Documentation#
This section contains the Python API reference for NGApp. It is useful when you want to look up available classes, functions, and component options in detail.
The API is organised into the following parts:
QComponents – auto-generated wrappers for Quasar components (buttons, inputs, layouts, dialogs, and more).
Component modules – helper components, base component and specialised widgets built on top of Quasar and HTML elements:
Utils – general utility functions used when working with files, environments, and other NGApp internals.
If you are just getting started, you usually do not need to read the full API reference. Start with Getting Started, Components, and the Tutorials first, then return here when you need finer details.
- QComponents
QAjaxBarQAvatarQBadgeQBannerQBarQBreadcrumbsQBreadcrumbsElQBtnQBtnDropdownQBtnGroupQBtnToggleQCardQCardActionsQCardSectionQCarouselQCarouselControlQCarouselSlideQChatMessageQCheckboxQChipQCircularProgressQColorQDateQDialogQDrawerQEditorQExpansionItemQFabQFabActionQFieldQFileQFooterQFormQFormChildMixinQHeaderQIconQImgQInfiniteScrollQInnerLoadingQInputQIntersectionQItemQItemLabelQItemSectionQKnobQLayoutQLinearProgressQListQMarkupTableQMenuQNoSsrQOptionGroupQPageQPageContainerQPageScrollerQPageStickyQPaginationQParallaxQPopupEditQPopupProxyQPullToRefreshQRadioQRangeQRatingQResizeObserverQResponsiveQRouteTabQScrollAreaQScrollObserverQSelectQSeparatorQSkeletonQSlideItemQSlideTransitionQSliderQSpaceQSpinnerQSpinnerAudioQSpinnerBallQSpinnerBarsQSpinnerBoxQSpinnerClockQSpinnerCommentQSpinnerCubeQSpinnerDotsQSpinnerFacebookQSpinnerGearsQSpinnerGridQSpinnerHeartsQSpinnerHourglassQSpinnerInfinityQSpinnerIosQSpinnerOrbitQSpinnerOvalQSpinnerPieQSpinnerPuffQSpinnerRadioQSpinnerRingsQSpinnerTailQSplitterQStepQStepperQStepperNavigationQTabQTabPanelQTabPanelsQTableQTabsQTdQThQTimeQTimelineQTimelineEntryQToggleQToolbarQToolbarTitleQTooltipQTrQTreeQUploaderQUploaderAddTriggerQVideoQVirtualScroll
- Helper Components
- Visualization Components
- Material Components
- Base Component
- Utils
BaseFrontendComputeEnvironmentEnvironmentEnvironmentTypecall_js()copy_simulation()error()get_job_component()is_production()is_pyodide()load_simulation()log()new_simulation()print_exception()read_file()read_file_binary()read_json()set_directory()temp_dir_with_files()time_now()warning()write_file()write_json()zip_directory()zip_modules()