Back to bricks list
Introduction Getting Started
Architecture
Technical Documentation
Other Classes
AbstractDbManager AgentFactory AudioView AuthService BadRequestException BarPlotView Base BaseEnvShell BaseHTTPException BaseModelDTO BaseTestCase BaseTestCaseLight BashCodeParam BoolParam BoolRField BoolValidator BoxPlotView BrickMigration BrickService CheckBeforeTaskResult CommunityService Compress CondaShellProxy Config ConfigParams Connector ConnectorPartSpec ConnectorSpec ConverterRunner Credentials CredentialsDataBasic CredentialsDataLab CredentialsDataOther CredentialsDataS3 CredentialsParam CredentialsType CurrentUserService Dashboard DashboardType DataframeAggregatorHelper DataframeDataFilterHelper DataframeFilterHelper DataFrameRField DataframeScalerHelper datetime DateTimeUTC DbConfig DictRField DictValidator DispatchedMessage DynamicInputs DynamicOutputs EntityNavigator EntityNavigatorService EntityTag EntityType Enum ExceptionHandler ExceptionResponse ExpressionBuilder ExternalApiService FileDownloader FileHelper FileRField FloatParam FloatRField FloatValidator ForbiddenException FrontService FrontTheme FSNodeModel FsNodeService GwsCorePackages GWSException GzipCompress HeatmapView HistogramView ImageView InPort Inputs InputSpec InputSpecs InterfaceSpec IntParam IntRField IntValidator IO IOface Job JsonCodeParam JSONField JSONView JuliaCodeParam KVStore LazyViewParam LinePlot2DView ListParam ListRField ListValidator Logger MailService MambaShellProxy MessageDispatcher MessageLevel MessageObserver Model ModelService Monitor MonitorService MultiViews NetworkView Note Notebook NoteParam NoteSearchBuilder NoteService NoteTemplate NoteTemplateParam NoteTemplateService NotFoundException NumericHelper NumericParam NumericValidator OpenAiChat OpenAiChatMessage OpenAiChatParam OpenAiHelper OutPort Outputs OutputSpec OutputSpecs PackageHelper Paginator ParamSet ParamSpec PerlCodeParam PipShellProxy PlotlyRField PlotlyView PoolDb Port PrimitiveRField Process ProcessFactory ProcessModel ProcessProxy ProcessSpec ProgressBar ProgressBarMessageObserver ProgressBarService ProtocolModel ProtocolProxy ProtocolService ProtocolTyping PythonCodeParam Queue QueueService RCodeParam Requests ResourceDownloaderBase ResourceModel ResourceOrigin ResourceRField ResourceSearchBuilder ResourceService ResourceTransfertService ResourceTyping RField RichText RichTextBlock RichTextBlockModificationDTO RichTextBlockModificationWithUserDTO RichTextBlockType RichTextDTO RichTextFigureData RichTextFileData RichTextFormulaData RichTextListData RichTextListItem RichTextModificationDifferenceDTO RichTextModificationsDTO RichTextModificationType RichTextNoteResourceViewData RichTextObjectType RichTextParagraphData RichTextParagraphHeaderData RichTextParagraphHeaderLevel RichTextParagraphListData RichTextParagraphListItemData RichTextParagraphText RichTextResourceViewData RichTextTimestampData RichTextUserDTO RichTextVariableData RichTextView RichTextViewFileData S3Bucket ScatterPlot2DView Scenario ScenarioCreationType ScenarioProcessStatus ScenarioProxy ScenarioRunService ScenarioSaveDTO ScenarioSearchBuilder ScenarioService ScenarioStatus ScenarioTemplate ScenarioTemplateFactory ScenarioTransfertService SearchBuilder SerializableObjectJson SerializableRField Settings ShellProxy SimpleTextView SpaceFolder SqlMigrator StackedBarPlotView StreamlitApp StreamlitAppManager StreamlitProcess StringHelper StrParam StrRField StrValidator SysProc TableAnnotatorHelper TableColumnSelector TableColumnTagToRowExtractor TableColumnTagUnfolder TableConcatHelper TableHeaderInfo TableOperationHelper TableRowSelector TableRowTagToColumnExtractor TableRowTagUnfolder TableScalerHelper TableTagAggregatorHelper TableUnfolderHelper TableView TabularView Tag TagHelper TagKeyModel TagService TagsParam TagValueModel TarCompress TarGzCompress TaskFileDownloader TaskHelper TaskInputs TaskModel TaskProxy TaskRunner TaskService TaskTyping TechnicalInfo TextParam TextView TextViewData Typing TypingDeprecated TypingIconColor TypingIconType TypingManager TypingStyle UnauthorizedException URLValidator User UserCredentialsDTO UserGroup UserService Utils UUIDRField Validator VennDiagramView Version View ViewTester ViewType YamlCodeParam ZipCompress
Version

EntityNavigator

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def getitem(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

Functions
__INIT__

Initialize self. See help(type(self)) for accurate signature.

Parameters:
NameTypeDefault valueDescription
entitiesUnion
DELETE_PROPAGATED_TAGS
Parameters:
NameTypeDefault valueDescription
tagsList
entity_tags_cacheDict
GET_AS_NAV_SET
Return type:
NavigableEntitySet
GET_ENTITIES_AS_SET
Return type:
Set
GET_ENTITIES_LIST
Return type:
List
GET_FIRST_ENTITY
Return type:
Optional
GET_NEXT_ENTITIES

Return all the entities that are linked to the current entities

Parameters:
NameTypeDefault valueDescription
requested_entitiesList [description] [entitytype]
Return type:
NavigableEntitySet
GET_NEXT_ENTITIES_RECURSIVE

Return all the entities that are linked to the current entities

Parameters:
NameTypeDefault valueDescription
requested_entitiesList [description] [entitytype]
include_current_entitiesbool False
Return type:
NavigableEntitySet
GET_NEXT_NOTES
Return type:
EntityNavigatorNote
GET_NEXT_RESOURCES
Return type:
EntityNavigatorResource
GET_NEXT_SCENARIOS
Return type:
EntityNavigatorScenario
GET_NEXT_VIEWS
Return type:
EntityNavigatorView
GET_PREVIOUS_ENTITIES_RECURSIVE

Return all the entities that are linked to the current entities

Parameters:
NameTypeDefault valueDescription
requested_entitiesList [description] [entitytype]
include_current_entitiesbool False
Return type:
NavigableEntitySet
GET_PREVIOUS_NOTES
Return type:
EntityNavigatorNote
GET_PREVIOUS_RESOURCES
Return type:
EntityNavigatorResource
GET_PREVIOUS_SCENARIOS
Return type:
EntityNavigatorScenario
GET_PREVIOUS_VIEWS
Return type:
EntityNavigatorView
HAS_ENTITIES
Return type:
bool
HAS_NEXT_ENTITIES
Parameters:
NameTypeDefault valueDescription
requested_entitiesList
Return type:
bool
IS_EMPTY
Return type:
bool
PROPAGATE_TAGS
Parameters:
NameTypeDefault valueDescription
tagsList
entity_tags_cacheDict
FROM_ENTITY_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
entity_typeEntityType
entity_idstr
Return type:
EntityNavigator