Dataloop JS SDK - v0.0.93
Table of contents
README.md
App Debug
Interfaces
- DlMockData
- iAppSettings
- IAppNavigator
- EventPayload
- IAgentMessageSource
- IAgentMessage
- DlNavigationOptions
- JsSDK
- IBundle
- ISupportedSlots
- IResource
- IConditions
- IPanelConfig
- IInvoke
- ToolbarInvoke
- IToolbarBase
- IToolbarConfig
- IPipelineNode
- IComputeConfigs
- IFunction
- IModuleConfig
- IComponents
- IAppSettings
- ICrumbConfig
- ISidePanelConfig
- IRoute
- SlotConfig
- IEntity
- IAccount
- IAnnotation
- AnnotationMetaData
- SystemAnnotationMetaData
- AnnotationChanges
- IAttributeSection
- IAttributeInstruction
- CreateAttributePayloadV2
- UpdateAttributePayloadV2
- IAttributeRange
- IAttributeHierarchy
- IDataset
- IDriver
- IExecution
- SDKExecutionPayload
- IGroup
- IIntegration
- IItem
- ILabel
- ILabelDisplayData
- ILabelDisplayImage
- ILabelScope
- ILabelTreeNode
- CreateLabelPayloadV2
- UpdateLabelNodePayloadV2
- ISDKLabelTreeNode
- IOntology
- OntologyQueryV2
- CreateOntologyPayloadV2
- UpdateOntologyPayloadV2
- IOrg
- IPipeline
- IProject
- IPagedResponse
- IQueryOptions
- IRecipeMetaData
- IRecipeOntology
- IRecipe
- IToolOptions
- RecipePayloadV2
- RecipesQueryV2
- PartialRecipePayloadV2
- IStructure
- CreateStructurePayloadV2
- UpdateStructurePayloadV2
- ITask
- SDKUpdateTaskAssigneesPayload
- IUser
- IContributor
- IAnnotationSnapshot
- SDKTimeServiceSettings
Classes
- DlMockDriver
- AppSettings
- xFrameDriver
- SDKNavigator
- GuestApp
- XFrameManager
- CrudMessage
- FrameAgent
- PeerAgent
- AgentMessage
- DlNavigationMessage
- XFrameMessage
- XFrameMessageError
- SDKAccount
- SDKAnnotation
- SDKAnnotationEvent
- SDKAttributeInstruction
- APIAttributeSectionV2
- SDKDataset
- SDKDriver
- SDKExecution
- SDKFunctionExecution
- SDKGroup
- SDKIntegration
- SDKItem
- APILabelV2
- APILabelTreeNodeV2
- SDKLabel
- SDKLabelTreeNode
- APIOntologyV2
- SDKOrg
- SDKPipeline
- SDKProject
- APIRecipeV2
- APIStructureV2
- SDKTask
- SDKUser
- SDKContributor
- SDKAnnotationSnapshot
- SnapshotService
Type Aliases
- CreatePayload
- CreateBulkPayload
- ReadPayload
- UpdatePayload
- UpdateBulkPayload
- DeletePayload
- DeleteBulkPayload
- QueryPayload
- StreamPayload
- FetchPayload
- ClonePayload
- LogsPayload
- SetStatusPayload
- DoesLabelHaveAttributesPayload
- CalcLabelsHaveAttributesPayload
- MissingRequiredAttributePayload
- ResourceHandler
- ResourceInstance
- IDate
- SDKAnnotationLogs
Enumerations
- ThemeType
- DlEvent
- DlFrameEvent
- DlAnnotationFrameEvent
- DlAnnotationEvent
- DlItemEvent
- DlItemFrameEvent
- AgentState
- AgentMessageType
- DlRoute
- AppMessageScope
- CrudType
- CrudEvent
- XFrameMessageType
- InvokeType
- CustomNodeScope
Functions
Type Aliases
CreatePayload
Ƭ CreatePayload<T>: any
Type parameters
| Name |
|---|
T |
CreateBulkPayload
Ƭ CreateBulkPayload<T>: any[]
Type parameters
| Name |
|---|
T |
ReadPayload
Ƭ ReadPayload<T>: string | Partial<T>
Type parameters
| Name |
|---|
T |
UpdatePayload
Ƭ UpdatePayload<T>: Partial<T>
Type parameters
| Name |
|---|
T |
UpdateBulkPayload
Ƭ UpdateBulkPayload<T>: Partial<T>[]
Type parameters
| Name |
|---|
T |
DeletePayload
Ƭ DeletePayload<T>: string | Partial<T>
Type parameters
| Name |
|---|
T |
DeleteBulkPayload
Ƭ DeleteBulkPayload<T>: string[]
Type parameters
| Name |
|---|
T |
QueryPayload
Ƭ QueryPayload<T>: any
Type parameters
| Name |
|---|
T |
StreamPayload
Ƭ StreamPayload<T>: any
Type parameters
| Name |
|---|
T |
FetchPayload
Ƭ FetchPayload<T>: string
Type parameters
| Name |
|---|
T |
ClonePayload
Ƭ ClonePayload<T>: string
Type parameters
| Name |
|---|
T |
LogsPayload
Ƭ LogsPayload<T>: Partial<T>
Type parameters
| Name |
|---|
T |
SetStatusPayload
Ƭ SetStatusPayload<T>: any
Type parameters
| Name |
|---|
T |
DoesLabelHaveAttributesPayload
Ƭ DoesLabelHaveAttributesPayload<T>: any
Type parameters
| Name |
|---|
T |
CalcLabelsHaveAttributesPayload
Ƭ CalcLabelsHaveAttributesPayload<T>: any
Type parameters
| Name |
|---|
T |
MissingRequiredAttributePayload
Ƭ MissingRequiredAttributePayload<T>: string
Type parameters
| Name |
|---|
T |
ResourceHandler
Ƭ ResourceHandler<T>: Object
Type parameters
| Name | Type |
|---|---|
T | any |
Type declaration
| Name | Type |
|---|---|
read? | ResponseResolver<ReadPayload<T>, T | undefined> |
getByName? | ResponseResolver<string, T | undefined> |
countByQuery? | ResponseResolver<QueryPayload<T>, number> |
create? | ResponseResolver<CreatePayload<T>, T | T[]> |
createBulk? | ResponseResolver<CreateBulkPayload<T>, T[]> |
update? | ResponseResolver<UpdatePayload<T>, T> |
updateBulk? | ResponseResolver<UpdateBulkPayload<T>, T[]> |
delete? | ResponseResolver<DeletePayload<T>, string | undefined> |
deleteBulk? | ResponseResolver<DeleteBulkPayload<T>, void> |
query? | ResponseResolver<QueryPayload<T>, IPagedResponse<T>> |
stream? | ResponseResolver<StreamPayload<T>, string> |
fetch? | ResponseResolver<FetchPayload<T>, any> |
clone? | ResponseResolver<ClonePayload<T>, T> |
logs? | ResponseResolver<LogsPayload<T>, any> |
setStatus? | ResponseResolver<CrudMessage<SetStatusPayload<T>>, void> |
doesLabelHaveAttributes? | ResponseResolver<DoesLabelHaveAttributesPayload<T>, boolean> |
calcLabelsHaveAttributes? | ResponseResolver<CalcLabelsHaveAttributesPayload<T>, void> |
missingRequiredAttribute? | ResponseResolver<MissingRequiredAttributePayload<T>, boolean> |
getLabelAttributes? | ResponseResolver<string, any> |
updateAssignees? | ResponseResolver<SDKUpdateTaskAssigneesPayload, T> |
ResourceInstance
Ƭ ResourceInstance: SDKProject | SDKDataset | SDKItem | SDKAnnotation | APIRecipeV2 | APIOntologyV2
IDate
Ƭ IDate: Date | number | string
SDKAnnotationLogs
Ƭ SDKAnnotationLogs: Object
Represents a collection of annotation events.
Index signature
▪ [annotationId: string]: SDKAnnotationEvent[]
Functions
initializeFrameDriver
▸ initializeFrameDriver(): Promise<void>
Returns
Promise<void>