Manta Developers
GitHub
Menu

@manta-eu/react/ldo-ui

Reference for @manta-eu/react/ldo-ui as it is on main.

Enumerations

NodeCategory

Enumeration Members

Ad: "ad"

AdSet

AdSet: "adset"

Campaign

Campaign: "campaign"

Creative

Creative: "creative"

Generic

Generic: "generic"

Platform

Platform: "platform"

Product

Product: "product"

Prompt

Prompt: "prompt"

RelationshipType

Enumeration Members

AdSetToCampaign

AdSetToCampaign: "adset-to-campaign"

AdToAdSet

AdToAdSet: "ad-to-adset"

CreativeToAd

CreativeToAd: "creative-to-ad"

Generic

Generic: "generic"

ProductToCreative

ProductToCreative: "product-to-creative"

PromptToCreative

PromptToCreative: "prompt-to-creative"

Classes

GraphErrorBoundary

Extends

Constructors

Constructor

new GraphErrorBoundary(props): GraphErrorBoundary

Parameters
props

GraphErrorBoundaryProps

Returns

GraphErrorBoundary

Overrides

Component<GraphErrorBoundaryProps, ErrorBoundaryState>.constructor

Properties

context

context: unknown

If using React Context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

Example
static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
See

React Docs

Inherited from

Component.context

props

readonly props: Readonly<P>

Inherited from

Component.props

state

state: Readonly<S>

Inherited from

Component.state

contextType?

static optional contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Example
type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
See

https://react.dev/reference/react/Component#static-contexttype

Inherited from

Component.contextType

propTypes?

static optional propTypes?: any

Ignored by React.

Deprecated

Only kept in types for backwards compatibility. Will be removed in a future major release.

Inherited from

Component.propTypes

Methods

componentDidCatch()

componentDidCatch(error, errorInfo): void

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters
error

Error

errorInfo

ErrorInfo

Returns

void

Overrides

Component.componentDidCatch

componentDidMount()?

optional componentDidMount(): void

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns

void

Inherited from

Component.componentDidMount

componentDidUpdate()?

optional componentDidUpdate(prevProps, prevState, snapshot?): void

Called immediately after updating occurs. Not called for the initial render.

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

Parameters
prevProps

Readonly<P>

prevState

Readonly<S>

snapshot?

any

Returns

void

Inherited from

Component.componentDidUpdate

componentWillMount()?

optional componentWillMount(): void

Called immediately before mounting occurs, and before Component.render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns

void

Deprecated

16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead; will stop working in React 17

See
Inherited from

Component.componentWillMount

componentWillReceiveProps()?

optional componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component.setState generally does not trigger this method.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters
nextProps

Readonly<P>

nextContext

any

Returns

void

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead; will stop working in React 17

See
Inherited from

Component.componentWillReceiveProps

componentWillUnmount()?

optional componentWillUnmount(): void

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

Returns

void

Inherited from

Component.componentWillUnmount

componentWillUpdate()?

optional componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component.setState here.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters
nextProps

Readonly<P>

nextState

Readonly<S>

nextContext

any

Returns

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

See
Inherited from

Component.componentWillUpdate

forceUpdate()

forceUpdate(callback?): void

Parameters
callback?

() => void

Returns

void

Inherited from

Component.forceUpdate

getSnapshotBeforeUpdate()?

optional getSnapshotBeforeUpdate(prevProps, prevState): any

Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render render causes changes to it.

Note: the presence of this method prevents any of the deprecated lifecycle events from running.

Parameters
prevProps

Readonly<P>

prevState

Readonly<S>

Returns

any

Inherited from

Component.getSnapshotBeforeUpdate

render()

render(): string | number | bigint | boolean | Element | Iterable<ReactNode, any, any> | Promise<AwaitedReactNode> | null | undefined

Returns

string | number | bigint | boolean | Element | Iterable<ReactNode, any, any> | Promise<AwaitedReactNode> | null | undefined

Overrides

Component.render

setState()

setState<K>(state, callback?): void

Type Parameters
K

K extends keyof ErrorBoundaryState

Parameters
state

ErrorBoundaryState | ((prevState, props) => ErrorBoundaryState | Pick<ErrorBoundaryState, K> | null) | Pick<ErrorBoundaryState, K> | null

callback?

() => void

Returns

void

Inherited from

Component.setState

shouldComponentUpdate()?

optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, Component.render, componentWillUpdate and componentDidUpdate will not be called.

Parameters
nextProps

Readonly<P>

nextState

Readonly<S>

nextContext

any

Returns

boolean

Inherited from

Component.shouldComponentUpdate

UNSAFE_componentWillMount()?

optional UNSAFE_componentWillMount(): void

Called immediately before mounting occurs, and before Component.render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns

void

Deprecated

16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead

See
Inherited from

Component.UNSAFE_componentWillMount

UNSAFE_componentWillReceiveProps()?

optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component.setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters
nextProps

Readonly<P>

nextContext

any

Returns

void

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead

See
Inherited from

Component.UNSAFE_componentWillReceiveProps

UNSAFE_componentWillUpdate()?

optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component.setState here.

This method will not stop working in React 17.

Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters
nextProps

Readonly<P>

nextState

Readonly<S>

nextContext

any

Returns

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead

See
Inherited from

Component.UNSAFE_componentWillUpdate

getDerivedStateFromError()

static getDerivedStateFromError(error): ErrorBoundaryState

Parameters
error

Error

Returns

ErrorBoundaryState

Type Aliases

ActionOperation

ActionOperation = "create" | "update" | "delete"

ActionPlanApproximateQuantitativeValue

ActionPlanApproximateQuantitativeValue = LdoQuantitativeBase & object

Type Declaration

__typename

__typename: "ApproximateQuantitativeValue"

maxValue

maxValue: string

minValue

minValue: string

unitCode

unitCode: string

ActionPlanChangesTableProps

ActionPlanChangesTableProps = object

Properties

emptyFallback?

optional emptyFallback?: ReactNode

planGraphIri

planGraphIri: string

rowRenderer?

optional rowRenderer?: ChangeRowRenderer

ActionPlanDetailModel

ActionPlanDetailModel = object

Properties

confidenceScore

confidenceScore: number | null

description

description: string | null

duration

duration: string | null

estimatedCost?

optional estimatedCost?: ActionPlanQuantitativeValue

estimatedReturn?

optional estimatedReturn?: ActionPlanQuantitativeValue

estimatedROI?

optional estimatedROI?: ActionPlanQuantitativeValue

graphDocument

graphDocument: RdfGraph

hasCurrentFacts

hasCurrentFacts: boolean

hasExecutionHistory

hasExecutionHistory: boolean

howTo

howTo: ActionPlanHowTo | null

iri

iri: string

potentialProfit?

optional potentialProfit?: ActionPlanQuantitativeValue

primaryIntegration

primaryIntegration: ActionPlanIntegration | null

state

state: ActionPlanDetailState

ActionPlanDetailState

ActionPlanDetailState = "DRAFT" | "RUNNING" | "COMPLETED" | "FAILED" | "TIMED_OUT"

ActionPlanExactQuantitativeValue

ActionPlanExactQuantitativeValue = LdoQuantitativeBase & object

Type Declaration

__typename

__typename: "ExactQuantitativeValue"

unitCode

unitCode: string

value

value: string

ActionPlanExecutionProvenanceResult

ActionPlanExecutionProvenanceResult = object

Properties

activities

activities: ExecutionProvenanceActivity[]

count

count: number

error

error: string | null

planActivityIri

planActivityIri: string | null

planDryRun

planDryRun: boolean

planEndedAtTime

planEndedAtTime: string | null

planErrorMessage

planErrorMessage: string | null

planStartedAtTime

planStartedAtTime: string | null

ActionPlanHowTo

ActionPlanHowTo = LdoHowToBase & object

Type Declaration

dateModified

dateModified: string | null

datePublished

datePublished: string | null

estimatedCost?

optional estimatedCost?: ActionPlanQuantitativeValue

estimatedReturn?

optional estimatedReturn?: ActionPlanQuantitativeValue

estimatedROI?

optional estimatedROI?: ActionPlanQuantitativeValue

id

id: string

step

step: ActionPlanHowToStepOrSection[]

supply?

optional supply?: ActionPlanHowToSupply[]

tool?

optional tool?: ActionPlanHowToTool[]

yield?

optional yield?: ActionPlanQuantitativeValue

ActionPlanHowToDirection

ActionPlanHowToDirection = LdoHowToDirectionBase & object

Type Declaration

__typename

__typename: "HowToDirection"

afterMedia?

optional afterMedia?: undefined

beforeMedia?

optional beforeMedia?: undefined

duringMedia?

optional duringMedia?: undefined

ActionPlanHowToDirectionOrTip

ActionPlanHowToDirectionOrTip = ActionPlanHowToDirection | ActionPlanHowToTip

ActionPlanHowToSection

ActionPlanHowToSection = LdoHowToSectionBase & object

Type Declaration

__typename

__typename: "HowToSection"

itemListElement

itemListElement: ActionPlanHowToStep[]

ActionPlanHowToStep

ActionPlanHowToStep = LdoHowToStepBase & object

Type Declaration

__typename

__typename: "HowToStep"

afterMedia?

optional afterMedia?: ActionPlanImageObject

beforeMedia?

optional beforeMedia?: ActionPlanImageObject

duringMedia?

optional duringMedia?: ActionPlanImageObject

image?

optional image?: ActionPlanImageObject

itemListElement?

optional itemListElement?: ActionPlanHowToDirectionOrTip[]

ActionPlanHowToStepOrSection

ActionPlanHowToStepOrSection = ActionPlanHowToStep | ActionPlanHowToSection

ActionPlanHowToSupply

ActionPlanHowToSupply = LdoHowToSupplyBase & object

Type Declaration

__typename

__typename: "HowToSupply"

estimatedCost?

optional estimatedCost?: ActionPlanQuantitativeValue

image?

optional image?: undefined

requiredQuantity?

optional requiredQuantity?: number | null

ActionPlanHowToTip

ActionPlanHowToTip = LdoHowToTipBase & object

Type Declaration

__typename

__typename: "HowToTip"

ActionPlanHowToTool

ActionPlanHowToTool = LdoHowToToolBase & object

Type Declaration

__typename

__typename: "HowToTool"

image?

optional image?: undefined

requiredQuantity?

optional requiredQuantity?: number | null

ActionPlanImageObject

ActionPlanImageObject = object

Properties

caption?

optional caption?: string

height?

optional height?: number

url

url: string

width?

optional width?: number

ActionPlanIntegration

ActionPlanIntegration = "META" | "GOOGLE" | "LINKEDIN" | "SHOPIFY" | "SNAPCHAT" | "WOOCOMMERCE"

ActionPlanIntegrationFilter

ActionPlanIntegrationFilter = ActionPlanIntegration | "NONE"

ActionPlanQuantitativeValue

ActionPlanQuantitativeValue = ActionPlanExactQuantitativeValue | ActionPlanApproximateQuantitativeValue

ActionPlansApprovalFilter

ActionPlansApprovalFilter = "NEEDS_APPROVAL" | "NO_PENDING"

ActionPlansAvailabilityFilter

ActionPlansAvailabilityFilter = "CURRENT" | "PAST_RUNS_ONLY" | "ALL"

ActionPlansListOrderDirection

ActionPlansListOrderDirection = "ASC" | "DESC"

ActionPlansListOrderField

ActionPlansListOrderField = "STATE" | "MANTA_PRIORITY" | "CREATED_AT"

ActionPlansListResult

ActionPlansListResult = object

Properties

plans

plans: ActionPlanSummary[]

totalCount

totalCount: number

ActionPlansListVariables

ActionPlansListVariables = object

Properties

approval?

optional approval?: ActionPlansApprovalFilter

availability?

optional availability?: ActionPlansAvailabilityFilter

graphIris?

optional graphIris?: string[]

integrations?

optional integrations?: ActionPlanIntegrationFilter[]

lastRunFrom?

optional lastRunFrom?: string

lastRunTo?

optional lastRunTo?: string

limit?

optional limit?: number

offset?

optional offset?: number

orderBy?

optional orderBy?: object

direction

direction: ActionPlansListOrderDirection

field

field: ActionPlansListOrderField

optional search?: string

states?

optional states?: ActionPlanDetailState[]

ActionPlanState

ActionPlanState = "DRAFT" | "RUNNING" | "COMPLETED" | "FAILED" | "TIMED_OUT"

ActionPlanSummary

ActionPlanSummary = ActionPlanDetailModel & object

Type Declaration

actionCount

actionCount: number

actionCountByType

actionCountByType: object[]

completedActionCount

completedActionCount: number

dryRun

dryRun: boolean

lastRunAt

lastRunAt: string | null

statements

statements: number

subjects

subjects: number

ActionPrefix

ActionPrefix = "Manta" | "Meta" | "Google" | "Gmc" | "Other"

ActionShapeDescriptor

ActionShapeDescriptor = object

Properties

iri

iri: CURIE

label?

optional label?: string

preview?

optional preview?: () => ChangeNode[]

Returns

ChangeNode[]

ActionShapeSpec

ActionShapeSpec = object

Properties

iri

iri: string

operations

operations: ReadonlyArray<ActionOperation>

targetRdfTypes

targetRdfTypes: ReadonlyArray<string>

ActivityAgentKind

ActivityAgentKind = "Person" | "SoftwareAgent"

ActivityDetail

ActivityDetail = object

Properties

endedAtTime

endedAtTime: string | null

errorMessage

errorMessage: string | null

iri

iri: string

planGraphIri

planGraphIri: string | null

planLabel

planLabel: string

startedAtTime

startedAtTime: string

status

status: ActivityStatus

ActivityFeedFilters

ActivityFeedFilters = object

Properties

search?

optional search?: string

status?

optional status?: ActivityStatusFilter

ActivityFeedItem

ActivityFeedItem = object

Properties

affectedCount

affectedCount: number

affectedIris

affectedIris: string[]

affectedTypeName

affectedTypeName: string | null

agentKind

agentKind: ActivityAgentKind

agentLabel

agentLabel: string | null

endedAtTime

endedAtTime: string | null

errorMessage

errorMessage: string | null

humanAffectedLabel

humanAffectedLabel: string

iri

iri: string

planGraphIri

planGraphIri: string | null

planLabel

planLabel: string

startedAtTime

startedAtTime: string

ActivityFeedResult

ActivityFeedResult = object

Properties

activities

activities: ActivityFeedItem[]

totalCount

totalCount: number

ActivityStatus

ActivityStatus = "completed" | "failed" | "running"

ActivityStatusFilter

ActivityStatusFilter = "all" | "completed" | "failed" | "running"

AggregateOutput

AggregateOutput = object

Properties

segments

segments: NarrativeSegment[]

value

value: string

variable

variable: string

BaseNodeProps

BaseNodeProps = object

Properties

accentColor?

optional accentColor?: string

badge?

optional badge?: string

children

children: ReactNode

id

id: string

label

label: string

onContextMenu?

optional onContextMenu?: (e) => void

Parameters
e

React.MouseEvent

Returns

void

selected

selected: boolean

BindFormulaPresentation

BindFormulaPresentation = object

Properties

expression

expression: string

groundedExpression

groundedExpression: string

index

index: number

inputs

inputs: FormulaInput[]

result

result: string

BuildChangeTreeOptions

BuildChangeTreeOptions = object

Properties

fieldEditsBySubject?

optional fieldEditsBySubject?: Record<string, FieldEdit[]>

ChangeEntityNode

ChangeEntityNode = NonNullable<ReturnType<typeof findEntityNode>>

ChangeLevel

ChangeLevel = PlanEntityMetric["level"] | "FIELD"

ChangeNode

ChangeNode = object

Properties

change

change: EntityChange

children

children: ChangeNode[]

id

id: string

integration

integration: ActionPlanIntegration | null

label

label: string

level

level: ChangeLevel

metrics

metrics: object

currentRoas

currentRoas: number | null

wastedSpend

wastedSpend: number | null

rollup

rollup: ChangeRollup

synthetic

synthetic: boolean

typeIri

typeIri: string

ChangeRollup

ChangeRollup = object

Properties

editCount

editCount: number

pauseCount

pauseCount: number

scaleCount

scaleCount: number

wastedSpendTotal

wastedSpendTotal: number | null

ChangeRowComponent

ChangeRowComponent = ComponentType<ChangeRowProps>

ChangeRowProps

ChangeRowProps = object

Properties

canExpand

canExpand: boolean

columnCount

columnCount: number

depth

depth: number

isExpanded

isExpanded: boolean

node

node: ChangeNode

onToggleExpand

onToggleExpand: () => void

Returns

void

whyCellStyle?

optional whyCellStyle?: CSSProperties

ChangeRowRenderer

ChangeRowRenderer = object

Properties

getRowComponent

getRowComponent: (node) => ChangeRowComponent

Parameters
node

ChangeNode

Returns

ChangeRowComponent

ChangeTableViewProps

ChangeTableViewProps = object

Properties

emptyFallback?

optional emptyFallback?: ReactNode

isLoading?

optional isLoading?: boolean

rowRenderer?

optional rowRenderer?: ChangeRowRenderer

tree

tree: ChangeNode[]

CollapsibleNodeProps

CollapsibleNodeProps = object

Properties

accentColor?

optional accentColor?: string

childCount

childCount: number

children

children: ReactNode

hasChildren

hasChildren: boolean

id

id: string

isCollapsed

isCollapsed: boolean

label

label: string

selected

selected: boolean

ConclusionCardProps

ConclusionCardProps = object

Properties

className?

optional className?: string

mode

mode: ExplainDisplayMode

onModeChange?

optional onModeChange?: (mode) => void

Parameters
mode

ExplainDisplayMode

Returns

void

tree

tree: NormalizedTree

ContextMenuState

ContextMenuState = object

Properties

nodeId

nodeId: string

nodeLabel

nodeLabel: string

x

x: number

y

y: number

CreateChangeRowRendererOptions

CreateChangeRowRendererOptions = object

Properties

fallback

fallback: ChangeRowComponent

overrides?

optional overrides?: Record<string, ChangeRowComponent>

CreateEntityTreeRowRendererOptions

CreateEntityTreeRowRendererOptions = object

Properties

fallback

fallback: EntityTreeRowComponent

overrides?

optional overrides?: Partial<Record<string, EntityTreeRowComponent>>

CreateGraphStoreOptions

CreateGraphStoreOptions = object

Properties

defaultViewMode?

optional defaultViewMode?: GraphViewMode

CreateNodeRouterOptions

CreateNodeRouterOptions = object

Properties

fallback

fallback: RDFNodeComponent

wrap

wrap: (View) => RDFNodeComponent

Parameters
View

EntityView

Returns

RDFNodeComponent

DatalogAstProps

DatalogAstProps = ComponentProps<"div"> & object

Type Declaration

rule

rule: string

DatalogCacheActions

DatalogCacheActions = object

Properties

clear

clear: () => void

Returns

void

parse

parse: (rule) => ParseResult

Parameters
rule

string

Returns

ParseResult

DatalogCacheState

DatalogCacheState = object

Properties

cache

cache: Map<string, ParseResult>

DatalogCacheStore

DatalogCacheStore = DatalogCacheState & DatalogCacheActions

DatalogCodeProps

DatalogCodeProps = object

Properties

className?

optional className?: string

code

code: string

Datastore

Datastore = object

Properties

badge?

optional badge?: string

depth?

optional depth?: number

id

id: string

name

name: string

selectable?

optional selectable?: boolean

DatastorePickerProps

DatastorePickerProps = object

Properties

currentDatastoreId?

optional currentDatastoreId?: string

datastores?

optional datastores?: Datastore[]

datastoreTree?

optional datastoreTree?: readonly DatastoreTreeNode[]

isLoadingTree?

optional isLoadingTree?: boolean

isOperator?

optional isOperator?: boolean

isSwitching?

optional isSwitching?: boolean

onDatastoreSelected

onDatastoreSelected: (datastoreId) => void

Parameters
datastoreId

string

Returns

void

DatastorePickerRow

DatastorePickerRow = object

Properties

active

active: boolean

badge?

optional badge?: string

depth?

optional depth?: number

heading?

optional heading?: boolean

id

id: string

name

name: string

note?

optional note?: string

treeDepth?

optional treeDepth?: number

DatastorePickerRowsArgs

DatastorePickerRowsArgs = object

Properties

currentDatastoreId?

optional currentDatastoreId?: string

datastoreTree?

optional datastoreTree?: readonly DatastoreTreeNode[]

isOperator?

optional isOperator?: boolean

userDatastores?

optional userDatastores?: Datastore[]

DatastoreRowContentProps

DatastoreRowContentProps = object

Properties

row

row: DatastorePickerRow

DatastoreTreeNode

DatastoreTreeNode = object

Properties

datastoreId?

optional datastoreId?: string | null

depth?

optional depth?: number

id

id: string

name

name: string

removed

removed: boolean

DetailView

DetailView = ComponentType<{ iri: string; }>

EditableRuleValue

EditableRuleValue = object

Properties

id

id: string

kind

kind: EditableRuleValueKind

replacementSpan

replacementSpan: SourceSpan

value

value: string

EditableRuleValueKind

EditableRuleValueKind = "number" | "date" | "dateTime"

EditableValueEntry

EditableValueEntry = object

Properties

edit

edit: EditableRuleValue

segments

segments: readonly NarrativeSegment[]

EditableValueNarrativeSegment

EditableValueNarrativeSegment = ValueNarrativeSegment & object

Type Declaration

edit

edit: EditableRuleValue

Entity

Entity<T> = T extends Record<string, unknown> ? { [Key in keyof T]: T[Key] } : T

Type Parameters

T

T

EntityCardProps

EntityCardProps = object

Properties

entityIri

entityIri: string

graph

graph: JsonLdGraphDocument

EntityChange

EntityChange = { kind: "PAUSE"; reason: string | null; } | { factor: number | null; kind: "BUDGET_SCALE"; next: number; previous: number; reason: string | null; } | { field: string; kind: "FIELD_EDIT"; next: string | null; previous: string | null; reason: string | null; } | { kind: "UNKNOWN"; }

EntityChipProps

EntityChipProps = object

Properties

className?

optional className?: string

icon?

optional icon?: LucideIcon

term

term: string

typeTerm?

optional typeTerm?: string

EntityLevel

EntityLevel = "CAMPAIGN" | "AD_SET" | "AD"

EntityLinkComponent

EntityLinkComponent = ComponentType<EntityLinkProps>

EntityLinkProps

EntityLinkProps = object

Properties

children

children: ReactNode

className?

optional className?: string

iri

iri: string

EntityLinkProviderProps

EntityLinkProviderProps = object

Properties

children

children: ReactNode

component

component: EntityLinkComponent

EntityMetricsResult

EntityMetricsResult = object

Properties

count

count: number

entities

entities: PlanEntityMetric[]

error

error: string | null

EntityNeighbor

EntityNeighbor = object

Properties

iri

iri: string

label

label: string

typeIri?

optional typeIri?: string

EntityNode

EntityNode = NonNullable<ReturnType<typeof findEntityNode>>

EntityRelationTreeProps

EntityRelationTreeProps = object

Properties

rootIri

rootIri: string

rootLabel?

optional rootLabel?: string

rootTypeIri?

optional rootTypeIri?: string

rowRenderer?

optional rowRenderer?: EntityTreeRowRenderer

EntityStripDisplayProps

EntityStripDisplayProps = object

Properties

className?

optional className?: string

iris

iris: string[]

View

View: ComponentType<{ iri: string; }>

EntityTreeNode

EntityTreeNode = object

Properties

ancestorIris

ancestorIris: string[]

Ancestor entity IRIs from the root down to the parent (excludes this node).

children

children: EntityTreeNode[]

childrenLoaded

childrenLoaded: boolean

hasChildren

hasChildren: boolean

When true, the row may expand even before children are loaded.

id

id: string

Path-unique row id (parentId>iri for nested rows); use iri for SPARQL / copy.

iri

iri: string

label

label: string

typeIri?

optional typeIri?: string

EntityTreeRowComponent

EntityTreeRowComponent = ComponentType<EntityTreeRowProps>

EntityTreeRowProps

EntityTreeRowProps = object

Properties

canExpand

canExpand: boolean

columnCount

columnCount: number

depth

depth: number

isExpanded

isExpanded: boolean

isLoadingChildren?

optional isLoadingChildren?: boolean

node

node: EntityTreeNode

onToggleExpand

onToggleExpand: () => void

Returns

void

EntityTreeRowRenderer

EntityTreeRowRenderer = object

Properties

getRowComponent

getRowComponent: (node) => EntityTreeRowComponent

Parameters
node

EntityTreeNode

Returns

EntityTreeRowComponent

EntityTreeTableProps

EntityTreeTableProps = object

Properties

emptyMessage?

optional emptyMessage?: string

isLoading?

optional isLoading?: boolean

loadingNodeIds?

optional loadingNodeIds?: ReadonlySet<string>

onRequestChildren?

optional onRequestChildren?: (node) => void

Parameters
node

EntityTreeNode

Returns

void

rowRenderer?

optional rowRenderer?: EntityTreeRowRenderer

tree

tree: EntityTreeNode[]

EntityViewWithLinksProps

EntityViewWithLinksProps = object

Properties

data

data: RDFNodeData

view

view: EntityView

ErrorBoundaryState

ErrorBoundaryState = object

Properties

error?

optional error?: Error

hasError

hasError: boolean

ExecutionProvenanceActivity

ExecutionProvenanceActivity = object

Properties

associatedAgentIris

associatedAgentIris: string[]

dryRun

dryRun: boolean

endedAtTime

endedAtTime: string | null

entities

entities: ExecutionProvenanceEntity[]

entityIri

entityIri: string | null

entityLabel

entityLabel: string

entityTypeName

entityTypeName: string | null

errorMessage

errorMessage: string | null

iri

iri: string

isPlanActivity

isPlanActivity: boolean

operationType

operationType: string | null

parentActivityIri

parentActivityIri: string | null

startedAtTime

startedAtTime: string | null

ExecutionProvenanceEntity

ExecutionProvenanceEntity = object

Properties

iri

iri: string

label

label: string | null

relation

relation: "used" | "generated" | "invalidated"

typeName

typeName: string | null

ExplainCompactViewProps

ExplainCompactViewProps = object

Properties

className?

optional className?: string

optional explainLink?: ReactNode

mode

mode: ExplainDisplayMode

onModeChange

onModeChange: (mode) => void

Parameters
mode

ExplainDisplayMode

Returns

void

outdatedFactNotice?

optional outdatedFactNotice?: ReactNode

subjectTerm

subjectTerm: string

substitutedFactNotice?

optional substitutedFactNotice?: ReactNode

tree

tree: NormalizedTree

ExplainDisplayMode

ExplainDisplayMode = "labels" | "datalog"

ExplainedFact

ExplainedFact = object

Indexable

[key: string]: unknown

Properties

fact?

optional fact?: string

rule-instances?

optional rule-instances?: ExplainRuleInstance[]

rule-instances-complete?

optional rule-instances-complete?: boolean

type?

optional type?: "derived" | "explicit" | "false"

ExplainFactOutput

ExplainFactOutput = object

Index Signature

[key: string]: ExplainedFact | ExplainedFact[]

ExplainFactStateProps

ExplainFactStateProps = object

Properties

className?

optional className?: string

detail?

optional detail?: string

title

title: string

ExplainFullViewProps

ExplainFullViewProps = object

Properties

className?

optional className?: string

mode

mode: ExplainDisplayMode

onModeChange

onModeChange: (mode) => void

Parameters
mode

ExplainDisplayMode

Returns

void

subjectTerm

subjectTerm: string

substitutedFactNotice?

optional substitutedFactNotice?: ReactNode

tree

tree: NormalizedTree

ExplainInspectorProps

ExplainInspectorProps = object

Properties

className?

optional className?: string

selectedNodeId

selectedNodeId: string

tree

tree: NormalizedTree

ExplainRouteMessageProps

ExplainRouteMessageProps = object

Properties

className?

optional className?: string

detail?

optional detail?: string

title

title: string

variant

variant: ExplainRouteMessageVariant

ExplainRouteMessageVariant

ExplainRouteMessageVariant = "empty" | "error"

ExplainRouteSkeletonProps

ExplainRouteSkeletonProps = object

Properties

className?

optional className?: string

ExplainRuleInstance

ExplainRuleInstance = object

Indexable

[key: string]: unknown

Properties

body-facts?

optional body-facts?: (string | null)[]

grounded-rule?

optional grounded-rule?: string

rule?

optional rule?: string

rule-iri?

optional rule-iri?: string

ExplainTagProps

ExplainTagProps = object

Properties

children?

optional children?: ReactNode

className?

optional className?: string

icon?

optional icon?: LucideIcon

title?

optional title?: string

variant

variant: ExplainTagVariant

ExplainTagVariant

ExplainTagVariant = "computes" | "guard" | "absence" | "result" | "success" | "neutral"

ExternalLinkTarget

ExternalLinkTarget = object

Properties

entityTypeUri

entityTypeUri: string

externalId

externalId: string

nodeIri?

optional nodeIri?: string

FactNoticeProps

FactNoticeProps = object

Properties

className?

optional className?: string

provenance?

optional provenance?: FactProvenance

FactProvenance

FactProvenance = "explicit" | "derived" | "computed" | "unsupported" | "absent"

FactSpo

FactSpo = object

Properties

object

object: string

predicate?

optional predicate?: string

subject

subject: string

FactValueProps

FactValueProps = object

Properties

className?

optional className?: string

predicate?

optional predicate?: string

value

value: string

FieldEdit

FieldEdit = object

Properties

field

field: string

label

label: string

next

next: string | null

previous

previous: string | null

reason?

optional reason?: string | null

FlattenedRow

FlattenedRow = object

Properties

depth

depth: number

node

node: RDFNode

FormatMeasureOptions

FormatMeasureOptions = object

Properties

locale?

optional locale?: string

FormulaInput

FormulaInput = object

Properties

atomIndex?

optional atomIndex?: number

value?

optional value?: string

variable

variable: string

GenericViewProps

GenericViewProps = EntityViewProps & object

Type Declaration

defaultExpanded?

optional defaultExpanded?: boolean

onToggleCollapse?

optional onToggleCollapse?: () => void

Returns

void

previewHints?

optional previewHints?: PreviewFieldHints

GoogleAdGroupAdDisplayProps

GoogleAdGroupAdDisplayProps = GoogleAdGroupAdSingularDisplayProps

GoogleAdGroupAdPluralDisplayProps

GoogleAdGroupAdPluralDisplayProps = object

Properties

businessName?

optional businessName?: string

className?

optional className?: string

iris

iris: readonly string[]

GoogleAdGroupAdSingularDisplayProps

GoogleAdGroupAdSingularDisplayProps = object

Properties

businessName?

optional businessName?: string

className?

optional className?: string

iri

iri: string

GraphActions

GraphActions = object

Properties

mergeGraph

mergeGraph: (newGraph) => void

Parameters
newGraph

RdfGraph

Returns

void

resetForNewGraph

resetForNewGraph: (graph) => void

Parameters
graph

RdfGraph

Returns

void

setCollapsedNodeIds

setCollapsedNodeIds: (updater) => void

Parameters
updater

Set<string> | ((prev) => Set<string>)

Returns

void

setContextMenu

setContextMenu: (menu) => void

Parameters

ContextMenuState | undefined

Returns

void

setHasInitializedListCollapse

setHasInitializedListCollapse: (initialized) => void

Parameters
initialized

boolean

Returns

void

setIsGraphReady

setIsGraphReady: (ready) => void

Parameters
ready

boolean

Returns

void

setListPage

setListPage: (page) => void

Parameters
page

number

Returns

void

setSelectedNode

setSelectedNode: (node) => void

Parameters
node

RDFNodeData | undefined

Returns

void

setSummaryView

setSummaryView: (isSummaryView) => void

Parameters
isSummaryView

boolean

Returns

void

setViewMode

setViewMode: (viewMode) => void

Parameters
viewMode

GraphViewMode

Returns

void

toggleCollapsedNode

toggleCollapsedNode: (nodeId) => void

Parameters
nodeId

string

Returns

void

toggleLayoutDirection

toggleLayoutDirection: () => void

Returns

void

toggleSummaryView

toggleSummaryView: () => void

Returns

void

toggleViewMode

toggleViewMode: () => void

Returns

void

GraphContextPanelProps

GraphContextPanelProps = object

Properties

graphCount

graphCount: number

mergedGraph

mergedGraph: JsonLdGraphDocument

nodeCount

nodeCount: number

renderGraph

renderGraph: (mergedGraph) => ReactNode

Parameters
mergedGraph

JsonLdGraphDocument

Returns

ReactNode

sparqlQueries

sparqlQueries: string[]

GraphContextValue

GraphContextValue = object

Properties

layoutDirection

layoutDirection: LayoutDirection

onNodeContextMenu

onNodeContextMenu: OnNodeContextMenu

onSelectNode

onSelectNode: (node) => void

Parameters
node

RDFNode

Returns

void

onToggleCollapse

onToggleCollapse: (nodeId) => void

Parameters
nodeId

string

Returns

void

previewHints?

optional previewHints?: PreviewFieldHints

GraphControlsProps

GraphControlsProps = object

Properties

disableSummaryView?

optional disableSummaryView?: boolean

graph

graph: RdfGraph

graphContainerRef

graphContainerRef: RefObject<HTMLDivElement | null>

isFullscreen

isFullscreen: boolean

isSummaryView

isSummaryView: boolean

layoutDirection

layoutDirection: LayoutDirection

onToggleFullscreen

onToggleFullscreen: () => void

Returns

void

onToggleLayoutDirection

onToggleLayoutDirection: () => void

Returns

void

onToggleSummaryView

onToggleSummaryView: () => void

Returns

void

onToggleViewMode

onToggleViewMode: () => void

Returns

void

reactFlowInstance

reactFlowInstance: RefObject<ReactFlowInstance<RDFNode, RDFEdge> | null>

viewMode

viewMode: GraphViewMode

GraphErrorBoundaryProps

GraphErrorBoundaryProps = object

Properties

children

children: ReactNode

fallback?

optional fallback?: ReactNode

GraphListViewProps

GraphListViewProps = object

Properties

collapsedNodeIds

collapsedNodeIds: Set<string>

currentPage

currentPage: number

nodes

nodes: RDFNode[]

onPageChange

onPageChange: (page) => void

Parameters
page

number

Returns

void

parentChildMap

parentChildMap: Map<string, string[]>

planGraphIri?

optional planGraphIri?: string

renderHeader

renderHeader: (args) => ReactNode

Parameters
args

GraphListViewRenderHeaderArgs

Returns

ReactNode

renderRow

renderRow: (args) => ReactNode

Parameters
args

GraphListViewRenderRowArgs

Returns

ReactNode

selectedNodeId?

optional selectedNodeId?: string

GraphListViewRenderHeaderArgs

GraphListViewRenderHeaderArgs = object

Properties

nodeMap

nodeMap: Map<string, RDFNode>

nodes

nodes: RDFNode[]

planGraphIri?

optional planGraphIri?: string

GraphListViewRenderRowArgs

GraphListViewRenderRowArgs = object

Properties

depth

depth: number

isCollapsed

isCollapsed: boolean

isSelected

isSelected: boolean

node

node: RDFNode

parentLabel?

optional parentLabel?: string

planGraphIri?

optional planGraphIri?: string

GraphProps

GraphProps = object

Properties

activeNodeIds?

optional activeNodeIds?: string[]

defaultViewMode?

optional defaultViewMode?: GraphViewMode

disableSummaryView?

optional disableSummaryView?: boolean

fullHeight?

optional fullHeight?: boolean

graph?

optional graph?: RdfGraph

jsonLd?

optional jsonLd?: JsonLdGraphDocument

onLoadRelationships?

optional onLoadRelationships?: LoadRelationships

planGraphIri?

optional planGraphIri?: string

previewHints?

optional previewHints?: PreviewFieldHints

renderListHeader?

optional renderListHeader?: (args) => ReactNode

Parameters
args

GraphListViewRenderHeaderArgs

Returns

ReactNode

renderListRow?

optional renderListRow?: (args) => ReactNode

Parameters
args

GraphListViewRenderRowArgs

Returns

ReactNode

renderPropertyDiff?

optional renderPropertyDiff?: (args) => ReactNode

Parameters
args

RenderPropertyDiffArgs

Returns

ReactNode

GraphState

GraphState = object

Properties

collapsedNodeIds

collapsedNodeIds: Set<string>

contextMenu

contextMenu: ContextMenuState | undefined

graphVersion

graphVersion: number

hasInitializedListCollapse

hasInitializedListCollapse: boolean

isGraphReady

isGraphReady: boolean

isSummaryView

isSummaryView: boolean

layoutDirection

layoutDirection: LayoutDirection

listPage

listPage: number

mergedGraph

mergedGraph: RdfGraph

selectedNode

selectedNode: RDFNodeData | undefined

viewMode

viewMode: GraphViewMode

GraphStore

GraphStore = GraphState & GraphActions

GraphTheme

GraphTheme = object

Properties

canvas

canvas: object

background

background: string

dots

dots: string

edge

edge: object

default

default: string

defaultSelected

defaultSelected: string

label

label: string

relationship

relationship: Record<RelationshipType, string>

node

node: object

background

background: string

border

border: string

category

category: Record<NodeCategory, string>

selectedRing

selectedRing: string

text

text: string

textMuted

textMuted: string

GraphViewMode

GraphViewMode = "graph" | "list"

HtmlMessagePreviewProps

HtmlMessagePreviewProps = object

Properties

body

body: string

className?

optional className?: string

context

context: Record<string, unknown>

InstanceDetailViewProps

InstanceDetailViewProps = object

Properties

instance

instance: SampleInstance

InstanceLabel

InstanceLabel = string | null

InstanceLabelsProviderProps

InstanceLabelsProviderProps = object

Properties

children

children: ReactNode

LayoutOptions

LayoutOptions = object

Properties

nodeDimensions?

optional nodeDimensions?: NodeDimensions

nodesep?

optional nodesep?: number

ranksep?

optional ranksep?: number

LdoHowToBase

LdoHowToBase = object

Properties

confidenceScore

confidenceScore: number | null

description

description: string | null

inLanguage

inLanguage: string | null

name

name: string

performTime

performTime: string | null

prepTime

prepTime: string | null

totalTime

totalTime: string | null

LdoHowToDirectionBase

LdoHowToDirectionBase = object

Properties

position

position: number

text

text: string

LdoHowToSectionBase

LdoHowToSectionBase = object

Properties

name

name: string

position

position: number

LdoHowToStepBase

LdoHowToStepBase = object

Properties

name

name: string

position

position: number

text

text: string | null

timeRequired

timeRequired: string | null

url

url: string | null

LdoHowToSupplyBase

LdoHowToSupplyBase = object

Properties

name

name: string

url

url: string | null

LdoHowToTipBase

LdoHowToTipBase = object

Properties

position

position: number

text

text: string

LdoHowToToolBase

LdoHowToToolBase = object

Properties

name

name: string

url

url: string | null

LdoQuantitativeBase

LdoQuantitativeBase = object

Properties

unitCode

unitCode: string | null

unitText

unitText: string | null

LensEntity

LensEntity<S> = SchemaInterface<S> | { [Key in keyof SchemaInterface<S>]: SchemaInterface<S>[Key] }

Type Parameters

S

S extends Schema

LoadRelationships

LoadRelationships = (nodeIri, planGraphIri, depth) => Promise<JsonLdGraphDocument>

Parameters

nodeIri

string

planGraphIri

string

depth

number

Returns

Promise<JsonLdGraphDocument>

ManualAction

ManualAction = object

Properties

aboutIri?

optional aboutIri?: string | null

assignees

assignees: string[]

defaultResolution?

optional defaultResolution?: "COMPLETED" | "RETRY" | null

description?

optional description?: string | null

label?

optional label?: string | null

observedValue?

optional observedValue?: string | null

retryable?

optional retryable?: boolean

status

status: ManualActionStatus | null

subjectIri

subjectIri: string

subjectLabel

subjectLabel: string | null

typeIri

typeIri: string

typeName

typeName: string

unstarted?

optional unstarted?: boolean

ManualActionEntity

ManualActionEntity = LensEntity<typeof MantaManualActionSchema>

ManualActionReadOptions

ManualActionReadOptions = object

Properties

includeUnstarted?

optional includeUnstarted?: boolean

ManualActionResolution

ManualActionResolution = Exclude<ManualActionStatus, "PENDING">

ManualActionResolving

ManualActionResolving = object

Properties

resolution

resolution: ManualActionResolution

subjectIri

subjectIri: string

ManualActionStatus

ManualActionStatus = typeof manualActionStatuses[number]

MarkdownMessagePreviewProps

MarkdownMessagePreviewProps = object

Properties

body

body: string

className?

optional className?: string

context

context: Record<string, unknown>

MaskedValueProps

MaskedValueProps = object

Properties

categories

categories: string[]

className?

optional className?: string

value

value: string

MeasureKind

MeasureKind = object

Properties

currency?

optional currency?: string

unit

unit: MeasureUnit

MeasureUnit

MeasureUnit = "currency" | "percent" | "count" | "ratio" | "decimal"

MetaAdDisplayProps

MetaAdDisplayProps = MetaAdSingularDisplayProps

MetaAdPluralDisplayProps

MetaAdPluralDisplayProps = object

Properties

businessName?

optional businessName?: string

className?

optional className?: string

iris

iris: readonly string[]

MetaAdSingularDisplayProps

MetaAdSingularDisplayProps = object

Properties

businessName?

optional businessName?: string

className?

optional className?: string

iri

iri: string

NamedFactSpo

NamedFactSpo = FactSpo & object

Type Declaration

namedGraph?

optional namedGraph?: string

objectDatatype?

optional objectDatatype?: string

NarrativeContext

NarrativeContext = object

Properties

mintedVariableNames

mintedVariableNames: ReadonlySet<string>

outputVariableNames

outputVariableNames: ReadonlySet<string>

showEntityVariables

showEntityVariables: boolean

variableLabels

variableLabels: ReadonlyMap<string, VariableLabel>

NarrativeRow

NarrativeRow = object

Properties

children?

optional children?: NarrativeRow[]

editContext?

optional editContext?: NarrativeSegment[]

graph?

optional graph?: DatalogTerm

muted?

optional muted?: boolean

segments

segments: NarrativeSegment[]

NarrativeSegment

NarrativeSegment = { kind: "text"; text: string; } | { graph?: DatalogTerm; kind: "entity"; prefix?: "has"; term?: string; text: string; title?: string; } | { kind: "variable"; name: string; } | ValueNarrativeSegment | { kind: "code"; text: string; }

NarrativeTag

NarrativeTag = "IF" | "AND" | "DO"

NodeContextMenuProps

NodeContextMenuProps = object

Properties

canLoadRelationships?

optional canLoadRelationships?: boolean

isExpanded?

optional isExpanded?: boolean

nodeData?

optional nodeData?: RDFNodeData

nodeId

nodeId: string

nodeLabel

nodeLabel: string

onClose

onClose: () => void

Returns

void

onCollapseAll?

optional onCollapseAll?: (nodeId) => void

Parameters
nodeId

string

Returns

void

onExpandAll?

optional onExpandAll?: (nodeId) => void

Parameters
nodeId

string

Returns

void

onExportNode?

optional onExportNode?: (nodeId) => void

Parameters
nodeId

string

Returns

void

onLoadRelationships?

optional onLoadRelationships?: (nodeId) => void

Parameters
nodeId

string

Returns

void

x

x: number

y

y: number

NodeDetailPanelProps

NodeDetailPanelProps = object

Properties

allNodes?

optional allNodes?: RDFNode[]

node

node: RDFNodeData

onClose?

optional onClose?: () => void

Returns

void

planGraphIri?

optional planGraphIri?: string

renderPropertyDiff?

optional renderPropertyDiff?: (args) => ReactNode

Parameters
args

RenderPropertyDiffArgs

Returns

ReactNode

NodeDimensions

NodeDimensions = object

Properties

height

height: number

width

width: number

NodeFrameProps

NodeFrameProps = object

Properties

children

children: ReactNode

edgeHandleColor?

optional edgeHandleColor?: string

showSourceHandle

showSourceHandle: boolean

showTargetHandle

showTargetHandle: boolean

NodeJsonViewProps

NodeJsonViewProps = object

Properties

className?

optional className?: string

jsonLd

jsonLd: Record<string, unknown>

message?

optional message?: string

NodePropertyChange

NodePropertyChange = object

Properties

beforeObject?

optional beforeObject?: string | null

beforeObjectLabel?

optional beforeObjectLabel?: string | null

changeType

changeType: PropertyChangeType

object

object: string

objectLabel?

optional objectLabel?: string | null

predicate

predicate: string

predicateLabel?

optional predicateLabel?: string | null

valueScale?

optional valueScale?: number

NodePropertyPreview

NodePropertyPreview = object

Properties

changeType?

optional changeType?: PropertyChangeType

currentRawValue?

optional currentRawValue?: string

currentValue?

optional currentValue?: string

id

id: string

isHighlighted?

optional isHighlighted?: boolean

label

label: string

predicate?

optional predicate?: string

previousRawValue?

optional previousRawValue?: string | null

previousValue?

optional previousValue?: string | null

rawValue?

optional rawValue?: string

value

value: string

NodeRouter

NodeRouter = object

Properties

getEntityView

getEntityView: (entityType?, actionShape?) => EntityView | undefined

Parameters
entityType?

string

actionShape?

IRI

Returns

EntityView | undefined

getNodeComponent

getNodeComponent: (entityType?, actionShape?) => RDFNodeComponent

Parameters
entityType?

string

actionShape?

IRI

Returns

RDFNodeComponent

NodesAndEdges

NodesAndEdges = object

Properties

edges

edges: RDFEdge[]

nodes

nodes: RDFNode[]

parentChildMap

parentChildMap: Map<string, string[]>

NormalizedNode

NormalizedNode = object

Properties

aggregateOutputs?

optional aggregateOutputs?: AggregateOutput[]

bodyIndex?

optional bodyIndex?: number

childIds

childIds: string[]

display

display: string

groundedDisplay?

optional groundedDisplay?: string

groundedRule?

optional groundedRule?: string

id

id: string

kind

kind: NormalizedNodeKind

narrative?

optional narrative?: readonly NarrativeSegment[]

negatedSpo?

optional negatedSpo?: FactSpo

parentId

parentId: string | null

provenance?

optional provenance?: FactProvenance

rule?

optional rule?: string

ruleIri?

optional ruleIri?: string

skolemTerm?

optional skolemTerm?: string

spo?

optional spo?: FactSpo

supports?

optional supports?: RuleInstanceView[]

NormalizedNodeKind

NormalizedNodeKind = "derived-fact" | "explicit-fact" | "aggregate" | "bind" | "filter" | "negation" | "skolem"

NormalizedTree

NormalizedTree = object

Properties

byId

byId: Record<string, NormalizedNode>

root

root: NormalizedNode

NumDotProps

NumDotProps = object

Properties

active?

optional active?: boolean

className?

optional className?: string

number

number: number

OntologyCommentProps

OntologyCommentProps = object

Properties

className?

optional className?: string

comment

comment: string

OntologyTerm

OntologyTerm = object

Properties

comment?

optional comment?: string

domainIncludes

domainIncludes: string[]

iri

iri: string

label?

optional label?: string

personalDataCategories

personalDataCategories: string[]

rangeIncludes

rangeIncludes: string[]

subClassOf

subClassOf: string[]

unitCode?

optional unitCode?: string

valueScale?

optional valueScale?: number

OntologyTermsProviderProps

OntologyTermsProviderProps = object

Properties

children

children: ReactNode

graphIri

graphIri: string

OntologyTermTextProps

OntologyTermTextProps = object

Properties

className?

optional className?: string

fallbackLabel?

optional fallbackLabel?: string

renderPrefix?

optional renderPrefix?: (label) => ReactNode

Parameters
label

string

Returns

ReactNode

resolveInstanceLabel?

optional resolveInstanceLabel?: boolean

term

term: string

title?

optional title?: string

tooltipExtra?

optional tooltipExtra?: ReactNode

OpenInPlatformLinkProps

OpenInPlatformLinkProps = object

Properties

className?

optional className?: string

iri

iri: IRI

onClick?

optional onClick?: (event) => void

Parameters
event

MouseEvent

Returns

void

redirectEndpoint?

optional redirectEndpoint?: string

schema

schema: object

@type

@type: IRI

PanelLabelProps

PanelLabelProps = object

Properties

children

children: ReactNode

className?

optional className?: string

optional right?: ReactNode

tickClassName?

optional tickClassName?: string

ParseResult

ParseResult = object

Properties

ast

ast: DatalogRule | null

error

error: string | null

PersonalDataResolution

PersonalDataResolution = { status: "pending"; } | { status: "failed"; } | { categories: string[]; status: "resolved"; }

PlanDiffByType

PlanDiffByType = object

Properties

addedCount

addedCount: number

typeIri

typeIri: string

typeName

typeName: string

updatedCount

updatedCount: number

PlanDiffResult

PlanDiffResult = object

Properties

byTypes

byTypes: PlanDiffByType[]

deleted

deleted: string[]

error?

optional error?: string | null

planGraph

planGraph: string

summary

summary: object

added

added: number

deleted

deleted: number

types

types: number

updated

updated: number

PlanEntityMetric

PlanEntityMetric = object

Properties

adsetIri

adsetIri: string | null

adsetLabel

adsetLabel: string | null

budgetIncreaseFactor

budgetIncreaseFactor: number | null

campaignIri

campaignIri: string | null

campaignLabel

campaignLabel: string | null

currentRoas

currentRoas: number | null

dailyBudget

dailyBudget: number | null

hierarchyLabel

hierarchyLabel: string

label

label: string

level

level: EntityLevel

pauseReason

pauseReason: string | null

previousDailyBudget

previousDailyBudget: number | null

scaleReason

scaleReason: string | null

subject

subject: string

typeIri

typeIri: string

wastedSpend

wastedSpend: number | null

PlanOperation

PlanOperation = "ADDED" | "UPDATED"

PlanSample

PlanSample = object

Properties

description?

optional description?: string

hierarchyLabel?

optional hierarchyLabel?: string

label?

optional label?: string

operation

operation: PlanOperation

properties

properties: PropertyChange[]

subject

subject: string

PlanSamplesResult

PlanSamplesResult = object

Properties

count

count: number

error

error: string | null

samples

samples: PlanSample[]

typeIri

typeIri: string

typeName

typeName: string

PluralView

PluralView = ComponentType<{ iris: string[]; }>

PreviewFieldHints

PreviewFieldHints = object

Properties

highlightPredicate?

optional highlightPredicate?: string

priorityPredicates?

optional priorityPredicates?: string[]

PriorityPreviewFieldsOptions

PriorityPreviewFieldsOptions = object

Properties

keepUnmatched?

optional keepUnmatched?: boolean

limit?

optional limit?: number

ProofSubjectHeaderProps

ProofSubjectHeaderProps = object

Properties

className?

optional className?: string

subjectTerm

subjectTerm: string

tree

tree: NormalizedTree

ProofTreeProps

ProofTreeProps = object

Properties

className?

optional className?: string

mode?

optional mode?: ExplainDisplayMode

onSelect?

optional onSelect?: (id) => void

Parameters
id

string

Returns

void

selectable?

optional selectable?: boolean

selectedNodeId?

optional selectedNodeId?: string

tree

tree: NormalizedTree

PropertyDiffViewProps

PropertyDiffViewProps = object

Properties

displayType?

optional displayType?: string

error?

optional error?: unknown

isLoading?

optional isLoading?: boolean

node

node: RDFNodeData

properties?

optional properties?: NodePropertyChange[]

ProvenanceActivity

ProvenanceActivity = object

Properties

agents

agents: ProvenanceAgent[]

dryRun

dryRun: boolean

endedAtTime

endedAtTime: string | null

errorMessage

errorMessage: string | null

generatedCount

generatedCount: number

invalidatedCount

invalidatedCount: number

iri

iri: string

operationType

operationType: string | null

startedAtTime

startedAtTime: string | null

ProvenanceAgent

ProvenanceAgent = object

Properties

iri

iri: string

label

label: string | null

type

type: "SoftwareAgent" | "Person"

ProvenanceBadgeProps

ProvenanceBadgeProps = object

Properties

className?

optional className?: string

provenance

provenance: FactProvenance

ProvenanceResult

ProvenanceResult = object

Properties

activities

activities: ProvenanceActivity[]

count

count: number

error

error: string | null

RDFEdge

RDFEdge = Edge<RDFEdgeData>

RDFEdgeData

RDFEdgeData = object

Properties

edgeIndex

edgeIndex: number

edgeSiblingCount

edgeSiblingCount: number

label

label: string

relationshipType

relationshipType: RelationshipType

RdfGraph

RdfGraph = Map<string, Map<string, RDF.Term[]>>

RDFNodeComponent

RDFNodeComponent = ComponentType<NodeProps<RDFNode>>

RedirectEndpointProviderProps

RedirectEndpointProviderProps = object

Properties

children

children: ReactNode

endpoint

endpoint: string

RefetchIntervalInput

RefetchIntervalInput = number | false | ((query) => number | false)

RenderPropertyDiffArgs

RenderPropertyDiffArgs = object

Properties

node

node: RDFNodeData

nodeIri

nodeIri: string

planGraphIri?

optional planGraphIri?: string

RenderTermProducers

RenderTermProducers = (term, graph) => ReactNode

Parameters

term

string

graph

DatalogTerm | undefined

Returns

ReactNode

ResolvedLink = object

Properties

href

href: string

label

label: string

RuleAtomPresentation

RuleAtomPresentation = object

Properties

groundedText

groundedText: string

index

index: number

kind

kind: NormalizedNodeKind

predicateTerm?

optional predicateTerm?: string

text

text: string

RuleHeadAtomPresentation

RuleHeadAtomPresentation = object

Properties

groundedText

groundedText: string

predicateTerm?

optional predicateTerm?: string

text

text: string

RuleInstanceView

RuleInstanceView = object

Properties

bodyFacts

bodyFacts: (string | null)[]

groundedRule?

optional groundedRule?: string

rule?

optional rule?: string

ruleIri?

optional ruleIri?: string

RuleNarrativeProps

RuleNarrativeProps = ComponentProps<"div"> & object

Type Declaration

colorVariables?

optional colorVariables?: boolean

model

model: RuleSetupModel

renderTermProducers?

optional renderTermProducers?: RenderTermProducers

RuleNarrativeSegmentsBaseProps

RuleNarrativeSegmentsBaseProps = object

Properties

segments

segments: readonly NarrativeSegment[]

RuleNarrativeSegmentsProps

RuleNarrativeSegmentsProps = RuleNarrativeSegmentsBaseProps & object | RuleNarrativeSegmentsBaseProps & object

RuleParser

RuleParser = (rule) => DatalogRule

Parameters

rule

string

Returns

DatalogRule

RulePresentation

RulePresentation = object

Properties

atoms

atoms: RuleAtomPresentation[]

bindings

bindings: VariableBinding[]

formula?

optional formula?: BindFormulaPresentation

groundedHeadText

groundedHeadText: string

groundedRuleText

groundedRuleText: string

headAtoms

headAtoms: RuleHeadAtomPresentation[]

headText

headText: string

name

name: string

nameTerm

nameTerm: string

resultVariable?

optional resultVariable?: string

ruleText

ruleText: string

RuleSelection

RuleSelection = object

Properties

highlightedAtomIndex?

optional highlightedAtomIndex?: number

node

node: NormalizedNode

relation

relation: "produces" | "uses"

RuleSetupModel

RuleSetupModel = object

Properties

ast

ast: DatalogRule

editableValues

editableValues: EditableValueEntry[]

rows

rows: TaggedNarrativeRow[]

RuleVariableTypesProps

RuleVariableTypesProps = object

Properties

className?

optional className?: string

ruleText

ruleText: string

ShaclFormContextValue

ShaclFormContextValue = object

Properties

availableShapeIris

availableShapeIris: Set<IRI>

formRef

formRef: RefObject<ShaclFormElement | null>

isLoadingShapes

isLoadingShapes: boolean

isValid

isValid: boolean

loadShapes

loadShapes: (shapeIri?) => void

Parameters
shapeIri?

IRI

Returns

void

refetchShapes

refetchShapes: () => void

Returns

void

serialize

serialize: (format?) => string | null

Parameters
format?

SerializationFormat

Returns

string | null

setIsValid

setIsValid: (isValid) => void

Parameters
isValid

boolean

Returns

void

setShapesGraph

setShapesGraph: (shapes) => void

Parameters
shapes

string

Returns

void

setValuesGraph

setValuesGraph: (values, subject?) => void

Parameters
values

string | null

subject?

string

Returns

void

setViewMode

setViewMode: (viewMode) => void

Parameters
viewMode

boolean

Returns

void

shapesError

shapesError: string | null

shapesGraph

shapesGraph: string | null

validate

validate: () => Promise<boolean>

Returns

Promise<boolean>

valuesGraph

valuesGraph: string | null

valuesSubject

valuesSubject: string | null

viewMode

viewMode: boolean

ShaclFormProps

ShaclFormProps = object

Properties

className?

optional className?: string

collapse?

optional collapse?: "open" | boolean

formRef?

optional formRef?: Ref<ShaclFormElement | null>

Reads the edited graph back out: the element carries the data, no event does.

language?

optional language?: string

onValidityChange?

optional onValidityChange?: (isValid) => void

Parameters
isValid

boolean

Returns

void

shapes

shapes: string

shapeSubject?

optional shapeSubject?: string

Picks the root node shape by IRI; without it the first one in the graph wins.

values?

optional values?: string

valuesSubject?

optional valuesSubject?: string

viewMode?

optional viewMode?: boolean

ShaclFormProviderProps

ShaclFormProviderProps = object

Properties

children

children: ReactNode

shapes

shapes: ShaclShapesSource

ShaclShapesSource

ShaclShapesSource = object

Properties

error

error: string | null

isLoading

isLoading: boolean

onSelectShape

onSelectShape: (shapeIri?) => void

Parameters
shapeIri?

IRI

Returns

void

refetch

refetch: () => void

Returns

void

shapeIris

shapeIris: readonly IRI[]

turtle

turtle: string | null

ShapeRegistryEntry

ShapeRegistryEntry = object

Properties

shapeTurtle

shapeTurtle: string

targetClass

targetClass: string

SlackMessagePreviewProps

SlackMessagePreviewProps = object

Properties

body

body: string

className?

optional className?: string

context

context: Record<string, unknown>

SparqlOptionsProviderProps

SparqlOptionsProviderProps = object

Properties

children

children: ReactNode

options

options: Options

writeOptions?

optional writeOptions?: Options

SubstitutedFactNoticeProps

SubstitutedFactNoticeProps = object

Properties

className?

optional className?: string

explained?

optional explained?: FactSpo

requested

requested: FactSpo

TableCoverageStatus

TableCoverageStatus = "covered" | "planned" | "unsupported"

TableLevel

TableLevel = "CAMPAIGN" | "AD_SET" | "AD"

TaggedNarrativeRow

TaggedNarrativeRow = NarrativeRow & object

Type Declaration

tag

tag: NarrativeTag

TypeEnrichment

TypeEnrichment = object

Properties

allInstances

allInstances: SampleInstance[]

isInEgoChain

isInEgoChain: boolean

sampleInstances

sampleInstances: SampleInstance[]

TypeSummaryListViewProps

TypeSummaryListViewProps = object

Properties

node

node: RDFNodeData

onSelectInstance

onSelectInstance: (instance) => void

Parameters
instance

SampleInstance

Returns

void

UseActionPlanDetailOptions

UseActionPlanDetailOptions = object

Properties

enabled?

optional enabled?: boolean

limit?

optional limit?: number

planGraphIri

planGraphIri: string

UseActionPlanDiffOptions

UseActionPlanDiffOptions = object

Properties

enabled?

optional enabled?: boolean

planGraphIri

planGraphIri: string

UseActionPlanEntityMetricsOptions

UseActionPlanEntityMetricsOptions = object

Properties

enabled?

optional enabled?: boolean

planGraphIri

planGraphIri: string

UseActionPlanExecutionProvenanceOptions

UseActionPlanExecutionProvenanceOptions = object

Properties

enabled?

optional enabled?: boolean

planGraphIri

planGraphIri: string

refetchIntervalMs?

optional refetchIntervalMs?: number | false

UseActionPlanGraphOptions

UseActionPlanGraphOptions = object

Properties

enabled?

optional enabled?: boolean

limit?

optional limit?: number

planGraphIri

planGraphIri: string

typeIri?

optional typeIri?: string

UseActionPlanProvenanceOptions

UseActionPlanProvenanceOptions = object

Properties

enabled?

optional enabled?: boolean

limit?

optional limit?: number

planGraphIri

planGraphIri: string

UseActionPlanSamplesOptions

UseActionPlanSamplesOptions = object

Properties

enabled?

optional enabled?: boolean

limit?

optional limit?: number

planGraphIri

planGraphIri: string

typeIri

typeIri: string

UseActionPlansListOptions

UseActionPlansListOptions = ActionPlansListVariables & object

Type Declaration

enabled?

optional enabled?: boolean

keepPreviousData?

optional keepPreviousData?: boolean

refetchInterval?

optional refetchInterval?: RefetchIntervalInput

UseActivityFeedOptions

UseActivityFeedOptions = object

Properties

enabled?

optional enabled?: boolean

filters?

optional filters?: ActivityFeedFilters

page?

optional page?: number

pageSize?

optional pageSize?: number

UseActivityOptions

UseActivityOptions = object

Properties

activityIri

activityIri: string | undefined

enabled?

optional enabled?: boolean

UseEntitiesByIrisOptions

UseEntitiesByIrisOptions<S> = object

Type Parameters

S

S extends Schema

Properties

enabled?

optional enabled?: boolean

iris

iris: readonly string[]

schema

schema: S

UseEntitiesOptions

UseEntitiesOptions<S> = object

Type Parameters

S

S extends Schema

Properties

enabled?

optional enabled?: boolean

schema

schema: S

UseEntityOptions

UseEntityOptions<S> = object

Type Parameters

S

S extends Schema

Properties

enabled?

optional enabled?: boolean

iri

iri: string

schema

schema: S

UseEntityRelationsOptions

UseEntityRelationsOptions<S> = object

Type Parameters

S

S extends Schema

Properties

enabled?

optional enabled?: boolean

iri

iri: string

schema

schema: S

UseManualActionsForPlansOptions

UseManualActionsForPlansOptions = object

Properties

enabled?

optional enabled?: boolean

planGraphIris

planGraphIris: string[]

refetchIntervalMs?

optional refetchIntervalMs?: number | false

UseManualActionsOptions

UseManualActionsOptions = ManualActionReadOptions & object

Type Declaration

enabled?

optional enabled?: boolean

planGraphIri

planGraphIri: string

refetchIntervalMs?

optional refetchIntervalMs?: number | false

UseSparqlConstructOptions

UseSparqlConstructOptions = object

Properties

enabled?

optional enabled?: boolean

keepPreviousData?

optional keepPreviousData?: boolean

query

query: string

queryKey

queryKey: readonly unknown[]

staleTime?

optional staleTime?: number

UseSparqlQueryOptions

UseSparqlQueryOptions<S> = object

Type Parameters

S

S extends Schema

Properties

enabled?

optional enabled?: boolean

iri?

optional iri?: string

options

options: Options

queryKey

queryKey: readonly unknown[]

schema

schema: S

UseSparqlSelectOptions

UseSparqlSelectOptions = object

Properties

enabled?

optional enabled?: boolean

query

query: string

queryKey

queryKey: readonly unknown[]

refetchInterval?

optional refetchInterval?: number | false | ((query) => number | false | undefined)

staleTime?

optional staleTime?: number

ValueNarrativeSegment

ValueNarrativeSegment = object

Properties

edit?

optional edit?: EditableRuleValue

kind

kind: "value"

text

text: string

title?

optional title?: string

ValuePillProps

ValuePillProps = object

Properties

children

children: ReactNode

className?

optional className?: string

VariableBinding

VariableBinding = object

Properties

predicate?

optional predicate?: string

term

term: DatalogTerm

value

value: string

variable

variable: string

VariableFocusState

VariableFocusState = object

Properties

activeVariable

activeVariable: string | null

relatedVariables

relatedVariables: ReadonlySet<string>

VariableLabel

VariableLabel = object

Properties

graph?

optional graph?: DatalogTerm

kind

kind: "class" | "predicate"

term

term: string

Variables

actionPlansListQueryKeyRoot

const actionPlansListQueryKeyRoot: readonly ["ldo-ui", "action-plans-list"]

BaseNode

const BaseNode: MemoExoticComponent<(props) => Element>

CollapsibleNode

const CollapsibleNode: MemoExoticComponent<(props) => Element>

connectedAccountEntityIrisQuery

const connectedAccountEntityIrisQuery: string

cs

const cs: NamespaceInterface

DatalogAst

const DatalogAst: ForwardRefExoticComponent<Omit<DatalogAstProps, "ref"> & RefAttributes<HTMLDivElement>>

datalogCacheStore

const datalogCacheStore: StoreApi<DatalogCacheStore>

datalogTextClass

const datalogTextClass: "truncate font-mono typography-small" = "truncate font-mono typography-small"

datastoreRowTestIdPrefix

const datastoreRowTestIdPrefix: "datastore-picker-item" = "datastore-picker-item"

defaultChangeRowRenderer

const defaultChangeRowRenderer: ChangeRowRenderer

defaultEntityTreeRowRenderer

const defaultEntityTreeRowRenderer: EntityTreeRowRenderer

defaultRedirectEndpoint

const defaultRedirectEndpoint: "/redirect" = "/redirect"

diffSubsumingViewIris

const diffSubsumingViewIris: ReadonlySet<IRI>

DynamicNode

const DynamicNode: MemoExoticComponent<(props) => Element>

edgeTypes

const edgeTypes: object

Type Declaration

labeledEdge

readonly labeledEdge: MemoExoticComponent<(props) => Element> = LabeledEdge

GenericNode

const GenericNode: MemoExoticComponent<(props) => Element>

GenericView

const GenericView: MemoExoticComponent<(props) => Element>

getEntityView

const getEntityView: (entityType?, actionShape?) => EntityView | undefined = router.getEntityView

Parameters

entityType?

string

actionShape?

string

Returns

EntityView | undefined

getNodeComponent

const getNodeComponent: (entityType?, actionShape?) => RDFNodeComponent = router.getNodeComponent

Parameters

entityType?

string

actionShape?

string

Returns

RDFNodeComponent

GraphContext

const GraphContext: Context<GraphContextValue | undefined>

GraphControls

const GraphControls: MemoExoticComponent<(props) => Element>

groundedDatalogCacheStore

const groundedDatalogCacheStore: StoreApi<DatalogCacheStore>

LabeledEdge

const LabeledEdge: MemoExoticComponent<(props) => Element>

listPageSize

const listPageSize: 25 = 25

m

const m: NamespaceInterface

mantaDarkTheme

const mantaDarkTheme: GraphTheme

mantaLightTheme

const mantaLightTheme: GraphTheme

manualActionStatuses

const manualActionStatuses: readonly ["PENDING", "COMPLETED", "REJECTED", "RETRY"]

maskText

const maskText: "•••••" = "•••••"

narrativeDatalogTextOptions

const narrativeDatalogTextOptions: object

Type Declaration

stripSimpleLiteralDatatypes

readonly stripSimpleLiteralDatatypes: true = true

NodeContextMenu

const NodeContextMenu: MemoExoticComponent<(props) => Element>

NodeFrame

const NodeFrame: MemoExoticComponent<(props) => Element>

nodeTypes

const nodeTypes: object

Type Declaration

rdfNode

readonly rdfNode: MemoExoticComponent<(props) => Element> = DynamicNode

typeSummaryNode

readonly typeSummaryNode: MemoExoticComponent<(props) => Element> = TypeSummaryNode

rdf

const rdf: NamespaceInterface

rdfTypeColors

const rdfTypeColors: Record<string, string>

realmDatastoreId

const realmDatastoreId: string

searchThreshold

const searchThreshold: 7 = 7

sectionLabelClass

const sectionLabelClass: "typography-tiny-semibold uppercase tracking-wider" = "typography-tiny-semibold uppercase tracking-wider"

selectionHighlightClass

const selectionHighlightClass: "border-l-primary bg-primary/10" = "border-l-primary bg-primary/10"

statusColors

const statusColors: Record<string, { bg: string; text: string; }>

supportedActionShapes

const supportedActionShapes: ReadonlyArray<ActionShapeSpec> = generatedActionShapes

TypeSummaryNode

const TypeSummaryNode: MemoExoticComponent<(props) => Element>

useInstanceLabel

const useInstanceLabel: (iri?) => InstanceLabel | undefined = resolver.useResolvedTerm

Parameters

iri?

string

Returns

InstanceLabel | undefined

useInstanceLabels

const useInstanceLabels: (iris) => Map<string, InstanceLabel> = resolver.useResolvedTerms

Parameters

iris

string[]

Returns

Map<string, InstanceLabel>

useOntologyTerm

const useOntologyTerm: (iri?) => OntologyTerm | undefined = resolver.useResolvedTerm

Parameters

iri?

string

Returns

OntologyTerm | undefined

useOntologyTerms

const useOntologyTerms: (iris) => Map<string, OntologyTerm> = resolver.useResolvedTerms

Parameters

iris

string[]

Returns

Map<string, OntologyTerm>

Functions

ActionPlanChangesTable()

ActionPlanChangesTable(props): Element

Parameters

props

ActionPlanChangesTableProps

Returns

Element

actionPrefixOf()

actionPrefixOf(iri): ActionPrefix

Parameters

iri

string

Returns

ActionPrefix

applyDagreLayout()

applyDagreLayout(nodes, edges, direction?, options?): RDFNode[]

Parameters

nodes

RDFNode[]

edges

RDFEdge[]

direction?

LayoutDirection = "LR"

options?

LayoutOptions

Returns

RDFNode[]

article()

article(label): string

Parameters

label

string

Returns

string

bindingCount()

bindingCount(bindings, key): number | undefined

Parameters

bindings

Bindings

key

string

Returns

number | undefined

bindingLiteralDatatype()

bindingLiteralDatatype(bindings, key): string | undefined

Parameters

bindings

Bindings

key

string

Returns

string | undefined

bindingValue()

bindingValue(bindings, key): string | undefined

Parameters

bindings

Bindings

key

string

Returns

string | undefined

buildChangeTree()

buildChangeTree(entities, options?): ChangeNode[]

Parameters

entities

PlanEntityMetric[]

options?

BuildChangeTreeOptions = {}

Returns

ChangeNode[]

buildEntitySubgraphsQuery()

buildEntitySubgraphsQuery(iris): string

Parameters

iris

string[]

Returns

string

buildExplainPath()

buildExplainPath(spo): string

Parameters

spo

NamedFactSpo

Returns

string

buildExplicitStateQuery()

buildExplicitStateQuery(planGraphIri): string

Parameters

planGraphIri

string

Returns

string

buildGraphologyGraph()

buildGraphologyGraph(jsonLd): Graph

Parameters

jsonLd

JsonLdGraphDocument

Returns

Graph

buildPreviewFields()

buildPreviewFields(queryProperties, localProperties, currencyCode, localStatusValue?): NodePropertyPreview[]

Parameters

queryProperties

NodePropertyChange[]

localProperties

NodeProperty[]

currencyCode

string | null

localStatusValue?

string

Returns

NodePropertyPreview[]

buildRuleNarrative()

buildRuleNarrative(rule): TaggedNarrativeRow[]

Parameters

rule

DatalogRule

Returns

TaggedNarrativeRow[]

buildRuleSetupModel()

buildRuleSetupModel(rule): RuleSetupModel

Parameters

rule

DatalogRule

Returns

RuleSetupModel

buildSinglePlanStateQuery()

buildSinglePlanStateQuery(planGraphIri): string

Parameters

planGraphIri

string

Returns

string

canPickDatastore()

canPickDatastore(args): boolean

Parameters

args
canSelect

boolean

canSwitchDatastore?

boolean

datastores?

readonly Datastore[]

isOperator?

boolean

Returns

boolean

changeReason()

changeReason(change): string | null

Parameters

change

EntityChange

Returns

string | null

ChangeRollupBadge()

ChangeRollupBadge(props): Element | null

Parameters

props
rollup

ChangeRollup

Returns

Element | null

ChangeTableView()

ChangeTableView(props): Element

Parameters

props

ChangeTableViewProps

Returns

Element

classLabel()

classLabel(iriOrPrefixedName): string

Parameters

iriOrPrefixedName

string

Returns

string

cleanOntologyComment()

cleanOntologyComment(raw?): string | undefined

Parameters

raw?

string

Returns

string | undefined

codeSegment()

codeSegment(text): NarrativeSegment

Parameters

text

string

Returns

NarrativeSegment

coerceActionPlanState()

coerceActionPlanState(raw): ActionPlanState

Parameters

raw

string | null | undefined

Returns

ActionPlanState

collectBindings()

collectBindings(stream): Promise<Bindings[]>

Parameters

stream

ResultStream<Bindings>

Returns

Promise<Bindings[]>

collectQuadsToGraph()

collectQuadsToGraph(stream): Promise<RdfGraph>

Parameters

stream

ResultStream<Quad>

Returns

Promise<RdfGraph>

computeEdgeSiblingIndices()

computeEdgeSiblingIndices(edges): void

Parameters

edges

RDFEdge[]

Returns

void

computeHubThreshold()

computeHubThreshold(connectionCounts): number

Parameters

connectionCounts

Map<string, number>

Returns

number

computeSummaryEnrichment()

computeSummaryEnrichment(jsonLd): Map<string, TypeEnrichment>

Parameters

jsonLd

JsonLdGraphDocument

Returns

Map<string, TypeEnrichment>

ConclusionCard()

ConclusionCard(props): Element

Parameters

props

ConclusionCardProps

Returns

Element

connectedAccountEntityIrisFromBindings()

connectedAccountEntityIrisFromBindings(bindings): ReadonlySet<string>

Pure binder: entity IRIs that a :ConnectedAccount points at via schema:sameAs.

Parameters

bindings

Bindings[]

Returns

ReadonlySet<string>

createChangeRowRenderer()

createChangeRowRenderer(options): ChangeRowRenderer

Parameters

options

CreateChangeRowRendererOptions

Returns

ChangeRowRenderer

createDatalogCacheStore()

createDatalogCacheStore(parse?): StoreApi<DatalogCacheStore>

Parameters

parse?

RuleParser = parseDatalogRule

Returns

StoreApi<DatalogCacheStore>

createEntityTreeRowRenderer()

createEntityTreeRowRenderer(options): EntityTreeRowRenderer

Parameters

options

CreateEntityTreeRowRendererOptions

Returns

EntityTreeRowRenderer

createGraphStore()

createGraphStore(initialGraph, options?): StoreApi<GraphStore>

Parameters

initialGraph

RdfGraph

options?

CreateGraphStoreOptions = {}

Returns

StoreApi<GraphStore>

createLiteral()

createLiteral(value): Term

Parameters

value

string

Returns

Term

createNamedNode()

createNamedNode(value): Term

Parameters

value

string

Returns

Term

createNodeRouter()

createNodeRouter(opts): NodeRouter

Parameters

opts

CreateNodeRouterOptions

Returns

NodeRouter

DatalogCode()

DatalogCode(props): Element

Parameters

props

DatalogCodeProps

Returns

Element

DatastorePicker()

DatastorePicker(props): Element

Parameters

props

DatastorePickerProps

Returns

Element

datastorePickerRows()

datastorePickerRows(args): DatastorePickerRow[]

Parameters

args

DatastorePickerRowsArgs

Returns

DatastorePickerRow[]

DatastoreRowContent()

DatastoreRowContent(props): Element

Parameters

props

DatastoreRowContentProps

Returns

Element

datastoreRowIndent()

datastoreRowIndent(row): CSSProperties | undefined

Parameters

row

DatastorePickerRow

Returns

CSSProperties | undefined

DefaultChangeRow()

DefaultChangeRow(props): Element

Parameters

props

ChangeRowProps

Returns

Element

DefaultEntityTreeRow()

DefaultEntityTreeRow(props): Element

Parameters

props

EntityTreeRowProps

Returns

Element

derivedHeadAtom()

derivedHeadAtom(headAtoms, factText): RuleHeadAtomPresentation | undefined

Parameters

headAtoms

RuleHeadAtomPresentation[]

factText

string | undefined

Returns

RuleHeadAtomPresentation | undefined

deriveEntityChange()

deriveEntityChange(metric): EntityChange

Parameters

metric

PlanEntityMetric

Returns

EntityChange

detectRelationshipType()

detectRelationshipType(sourceType?, targetType?): RelationshipType

Parameters

sourceType?

string

targetType?

string

Returns

RelationshipType

EntityCard()

EntityCard(props): Element

Parameters

props

EntityCardProps

Returns

Element

EntityChip()

EntityChip(props): Element

Parameters

props

EntityChipProps

Returns

Element

EntityLinkProvider()

EntityLinkProvider(props): Element

Parameters

props

EntityLinkProviderProps

Returns

Element

entityNodeFromChangeTriples()

entityNodeFromChangeTriples(subjectIri, triples): object & object & object | undefined

Parameters

subjectIri

string

triples

ActivityChangeTriple[]

Returns

object & object & object

undefined

EntityRelationTree()

EntityRelationTree(props): Element

Recursive entity-relation tree for a root IRI. Top-level neighbor rows start collapsed; expanding a row loads that entity’s neighbors on demand.

Parameters

props

EntityRelationTreeProps

Returns

Element

entitySegment()

entitySegment(text, title?, term?, graph?): NarrativeSegment

Parameters

text

string

title?

string

term?

string

graph?

DatalogTerm

Returns

NarrativeSegment

EntityStripDisplay()

EntityStripDisplay(props): Element

Parameters

props

EntityStripDisplayProps

Returns

Element

EntityTreeTable()

EntityTreeTable(props): Element

Parameters

props

EntityTreeTableProps

Returns

Element

EntityTypeIcon()

EntityTypeIcon(props): Element

Parameters

props
className?

string

level

ChangeLevel

Returns

Element

EntityViewWithLinks(props): Element

Parameters

props

EntityViewWithLinksProps

Returns

Element

ExplainCompactView()

ExplainCompactView(props): Element

Parameters

props

ExplainCompactViewProps

Returns

Element

ExplainFactState()

ExplainFactState(props): Element

Parameters

props

ExplainFactStateProps

Returns

Element

ExplainFullView()

ExplainFullView(props): Element

Parameters

props

ExplainFullViewProps

Returns

Element

ExplainInspector()

ExplainInspector(props): Element

Parameters

props

ExplainInspectorProps

Returns

Element

ExplainRouteMessage()

ExplainRouteMessage(props): Element

Parameters

props

ExplainRouteMessageProps

Returns

Element

ExplainRouteSkeleton()

ExplainRouteSkeleton(props): Element

Parameters

props

ExplainRouteSkeletonProps

Returns

Element

explainRuleAst()

explainRuleAst(rule): DatalogRule | undefined

Parameters

rule

string

Returns

DatalogRule | undefined

ExplainTag()

ExplainTag(props): Element

Parameters

props

ExplainTagProps

Returns

Element

extractNodeDisplayData()

extractNodeDisplayData(jsonLdNode): object

Parameters

jsonLdNode

JsonLdNode

Returns

object

label

label: string

properties

properties: object[]

FactNotice()

FactNotice(props): Element

Parameters

props

FactNoticeProps

Returns

Element

factTokenText()

factTokenText(token): string

Parameters

token

string

Returns

string

FactValue()

FactValue(props): Element

Parameters

props

FactValueProps

Returns

Element

filterDatastoreRows()

filterDatastoreRows(rows, search?): DatastorePickerRow[]

Parameters

rows

readonly DatastorePickerRow[]

search?

string

Returns

DatastorePickerRow[]

filterStatusProps()

filterStatusProps(properties): NodeProperty[]

Parameters

properties

NodeProperty[]

Returns

NodeProperty[]

filterVisibleNodesAndEdges()

filterVisibleNodesAndEdges(nodes, edges, collapsedNodeIds, parentChildMap): object

Parameters

nodes

RDFNode[]

edges

RDFEdge[]

collapsedNodeIds

Set<string>

parentChildMap

Map<string, string[]>

Returns

object

edges

edges: RDFEdge[]

nodes

nodes: RDFNode[]

findDetailViewForTypes()

findDetailViewForTypes(rdfTypes): DetailView | undefined

Parameters

rdfTypes

readonly string[]

Returns

DetailView | undefined

findEntityNode()

findEntityNode(nodes, entityIri): RDFNode | undefined

Parameters

nodes

RDFNode[]

entityIri

string

Returns

RDFNode | undefined

findPluralViewForTypes()

findPluralViewForTypes(rdfTypes): PluralView | undefined

Parameters

rdfTypes

readonly string[]

Returns

PluralView | undefined

findRepresentativeChain()

findRepresentativeChain(graph): Set<string>

Parameters

graph

Graph

Returns

Set<string>

findShapeForTypes()

findShapeForTypes(rdfTypes): ShapeRegistryEntry | undefined

Parameters

rdfTypes

string[]

Returns

ShapeRegistryEntry | undefined

formatDisplayValue()

formatDisplayValue(value, options?): string

Parameters

value

string

options?
currencyCode?

string | null

predicate?

string

predicateLabel?

string | null

valueScale?

number

Returns

string

formatMeasureValue()

formatMeasureValue(value, kind?, options?): string

Parameters

value

string

kind?

MeasureKind

options?

FormatMeasureOptions

Returns

string

formatRuleText()

formatRuleText(headText, atomTexts): string

Parameters

headText

string

atomTexts

string[]

Returns

string

formulaHueClass()

formulaHueClass(inputIndex): string

Parameters

inputIndex

number

Returns

string

formulaHueEdgeClass()

formulaHueEdgeClass(inputIndex): string

Parameters

inputIndex

number

Returns

string

formulaHueTextClass()

formulaHueTextClass(inputIndex): string

Parameters

inputIndex

number

Returns

string

getActionShapeDescriptor()

getActionShapeDescriptor(iri): ActionShapeDescriptor | undefined

Parameters

iri

string

Returns

ActionShapeDescriptor | undefined

getActionShapeSpec()

getActionShapeSpec(iri): ActionShapeSpec | undefined

Parameters

iri

string | undefined

Returns

ActionShapeSpec | undefined

getAllDescendants()

getAllDescendants(nodeId, parentChildMap): Set<string>

Parameters

nodeId

string

parentChildMap

Map<string, string[]>

Returns

Set<string>

getAllRegisteredShapes()

getAllRegisteredShapes(): ShapeRegistryEntry[]

Returns

ShapeRegistryEntry[]

getChannelFromId()

getChannelFromId(id): Channel | undefined

Parameters

id

string

Returns

Channel | undefined

getCurrencyCode()

getCurrencyCode(changes, properties): string | null

Parameters

changes

NodePropertyChange[]

properties

NodeProperty[]

Returns

string | null

getExternalLinkTarget()

getExternalLinkTarget(data): ExternalLinkTarget | undefined

Parameters

data

RDFNodeData

Returns

ExternalLinkTarget | undefined

getImageUrl()

getImageUrl(data): string | undefined

Parameters

data

RDFNodeData

Returns

string | undefined

getNodeCategory()

getNodeCategory(entityType?): NodeCategory

Parameters

entityType?

string

Returns

NodeCategory

getNodeChannel()

getNodeChannel(data): Channel | undefined

Parameters

data

RDFNodeData

Returns

Channel | undefined

getNodeDimensions()

getNodeDimensions(entityType?): NodeDimensions

Parameters

entityType?

string

Returns

NodeDimensions

getNumericProperty()

getNumericProperty(data, key): number | undefined

Parameters

data

RDFNodeData

key

string

Returns

number | undefined

getProperty()

getProperty(data, key): string | undefined

Parameters

data

RDFNodeData

key

string

Returns

string | undefined

getRuleBodyTerms()

getRuleBodyTerms(rule): string[]

Parameters

rule

string

Returns

string[]

getShapeForType()

getShapeForType(rdfType): ShapeRegistryEntry | undefined

Parameters

rdfType

string

Returns

ShapeRegistryEntry | undefined

getStatus()

getStatus(data): { key: string; value: string; } | undefined

Parameters

data

RDFNodeData

Returns

{ key: string; value: string; } | undefined

getStatusFromProperties()

getStatusFromProperties(properties): string | undefined

Parameters

properties

NodeProperty[]

Returns

string | undefined

getStatusPillColor()

getStatusPillColor(value): string

Parameters

value

string

Returns

string

getTableShapePreview()

getTableShapePreview(shape): ChangeNode[] | null

Parameters

shape

ActionShapeSpec

Returns

ChangeNode[] | null

getTheme()

getTheme(isDarkMode): GraphTheme

Parameters

isDarkMode

boolean

Returns

GraphTheme

GoogleAdGroupAdDisplay()

GoogleAdGroupAdDisplay(props): Element

Parameters

props

GoogleAdGroupAdSingularDisplayProps

Returns

Element

GoogleAdGroupAdPluralDisplay()

GoogleAdGroupAdPluralDisplay(props): Element

Parameters

props

GoogleAdGroupAdPluralDisplayProps

Returns

Element

GoogleAdGroupAdSingularDisplay()

GoogleAdGroupAdSingularDisplay(props): Element

Parameters

props

GoogleAdGroupAdSingularDisplayProps

Returns

Element

Graph()

Graph(props): Element

Parameters

props

GraphProps

Returns

Element

GraphContextPanel()

GraphContextPanel(props): Element | null

Parameters

props

GraphContextPanelProps

Returns

Element | null

GraphListView()

GraphListView(props): Element

Parameters

props

GraphListViewProps

Returns

Element

graphToEntityNodes()

graphToEntityNodes(graph, iris): Map<string, object & object & object>

Parameters

graph

RdfGraph

iris

string[]

Returns

Map<string, object & object & object>

groupActionShapesByPrefix()

groupActionShapesByPrefix(shapes): Map<ActionPrefix, ActionShapeSpec[]>

Parameters

shapes

readonly ActionShapeSpec[]

Returns

Map<ActionPrefix, ActionShapeSpec[]>

hasDatastoreChoice()

hasDatastoreChoice(datastores?): boolean

Parameters

datastores?

readonly Datastore[]

Returns

boolean

hasIncomingRelations()

hasIncomingRelations(data): boolean

Parameters

data

RDFNodeData

Returns

boolean

hasOutgoingRelations()

hasOutgoingRelations(data): boolean

Parameters

data

RDFNodeData

Returns

boolean

hasShapeForType()

hasShapeForType(rdfType): boolean

Parameters

rdfType

string

Returns

boolean

hasVisiblePremises()

hasVisiblePremises(tree): boolean

Parameters

tree

NormalizedTree

Returns

boolean

HtmlMessagePreview()

HtmlMessagePreview(props): Element

Parameters

props

HtmlMessagePreviewProps

Returns

Element

humanizePredicateName()

humanizePredicateName(predicate): string

Parameters

predicate

string

Returns

string

InstanceDetailView()

InstanceDetailView(props): Element

Parameters

props

InstanceDetailViewProps

Returns

Element

InstanceLabelsProvider()

InstanceLabelsProvider(props): Element

Parameters

props

InstanceLabelsProviderProps

Returns

Element

integrationForTypeIri()

integrationForTypeIri(typeIri): ActionPlanIntegration | null

Parameters

typeIri

string

Returns

ActionPlanIntegration | null

isEditableValueSegment()

isEditableValueSegment(segment): segment is EditableValueNarrativeSegment

Parameters

segment

NarrativeSegment

Returns

segment is EditableValueNarrativeSegment

isExplainFactOutput()

isExplainFactOutput(value): value is ExplainFactOutput

Parameters

value

unknown

Returns

value is ExplainFactOutput

isFactNode()

isFactNode(node): boolean

Parameters

node

NormalizedNode

Returns

boolean

isMaskedResolution()

isMaskedResolution(resolution): boolean

Parameters

resolution

PersonalDataResolution | undefined

Returns

boolean

isPendingManualAction()

isPendingManualAction(action): boolean

Parameters

action

ManualAction

Returns

boolean

isResolvedManualAction()

isResolvedManualAction(action): boolean

Parameters

action

ManualAction

Returns

boolean

isStatusField()

isStatusField(field): boolean

Parameters

field

NodePropertyPreview

Returns

boolean

isTypeFact()

isTypeFact(node): boolean

Parameters

node

NormalizedNode

Returns

boolean

isUnstartedManualAction()

isUnstartedManualAction(action): boolean

Parameters

action

ManualAction

Returns

boolean

jsonLdToRdfGraph()

jsonLdToRdfGraph(jsonLd): RdfGraph

Parameters

jsonLd

JsonLdGraphDocument

Returns

RdfGraph

jsonLdToTurtle()

jsonLdToTurtle(jsonLd, subjectIri): string

Parameters

jsonLd

Record<string, unknown>

subjectIri

string

Returns

string

kindForBodyFormula()

kindForBodyFormula(formula): NormalizedNodeKind

Parameters

formula

DatalogBodyFormula

Returns

NormalizedNodeKind

kindForSyntheticTerm()

kindForSyntheticTerm(term): NormalizedNodeKind

Parameters

term

string

Returns

NormalizedNodeKind

labeledEntitySegment()

labeledEntitySegment(term, kind, graph?): object

Parameters

term

string

kind

"class" | "predicate"

graph?

DatalogTerm

Returns

object

graph?

optional graph?: DatalogTerm

kind

kind: "entity"

prefix?

optional prefix?: "has"

term?

optional term?: string

text

text: string

title?

optional title?: string

MarkdownMessagePreview()

MarkdownMessagePreview(props): Element

Parameters

props

MarkdownMessagePreviewProps

Returns

Element

MaskedValue()

MaskedValue(props): Element

Parameters

props

MaskedValueProps

Returns

Element

maskSubstitutedLiterals()

maskSubstitutedLiterals(rawText, groundedText): string

Parameters

rawText

string

groundedText

string

Returns

string

measureFromUnitCode()

measureFromUnitCode(unitCode?): MeasureKind | undefined

Parameters

unitCode?

string

Returns

MeasureKind | undefined

mergeRdfGraphs()

mergeRdfGraphs(graphs): RdfGraph

Parameters

graphs

RdfGraph[]

Returns

RdfGraph

mergeStates()

mergeStates(provenanceState, explicitState): ActionPlanState

Parameters

provenanceState

ActionPlanState

explicitState

ActionPlanState | null

Returns

ActionPlanState

MetaAdDisplay()

MetaAdDisplay(props): Element

Parameters

props

MetaAdSingularDisplayProps

Returns

Element

MetaAdPluralDisplay()

MetaAdPluralDisplay(props): Element

Parameters

props

MetaAdPluralDisplayProps

Returns

Element

MetaAdSingularDisplay()

MetaAdSingularDisplay(props): Element

Parameters

props

MetaAdSingularDisplayProps

Returns

Element

multipleSupports()

multipleSupports(node): RuleInstanceView[] | undefined

Parameters

node

NormalizedNode

Returns

RuleInstanceView[] | undefined

narrativeSegmentsAroundEdit()

narrativeSegmentsAroundEdit(segments, activeEditId): readonly NarrativeSegment[]

Parameters

segments

readonly NarrativeSegment[]

activeEditId

string

Returns

readonly NarrativeSegment[]

neighborToTreeNode()

neighborToTreeNode(args): EntityTreeNode

Parameters

args
ancestorIris?

string[]

iri

string

label

string

parentId?

string

typeIri?

string

Returns

EntityTreeNode

nestedIndent()

nestedIndent(depth): CSSProperties | undefined

Parameters

depth

number

Returns

CSSProperties | undefined

NestedMarker()

NestedMarker(): Element

Returns

Element

NewValueCell()

NewValueCell(props): Element

Parameters

props
change

EntityChange

Returns

Element

NodeDetailPanel()

NodeDetailPanel(props): Element

Parameters

props

NodeDetailPanelProps

Returns

Element

NodeJsonView()

NodeJsonView(props): Element

Parameters

props

NodeJsonViewProps

Returns

Element

normalize()

normalize(output): NormalizedTree | null

Parameters

output

ExplainFactOutput

Returns

NormalizedTree | null

normalizeKey()

normalizeKey(key): string

Parameters

key

string

Returns

string

NumDot()

NumDot(props): Element

Parameters

props

NumDotProps

Returns

Element

OntologyComment()

OntologyComment(props): Element

Parameters

props

OntologyCommentProps

Returns

Element

ontologyTermIri()

ontologyTermIri(term): string | undefined

Parameters

term

string

Returns

string | undefined

ontologyTermIrisForChanges()

ontologyTermIrisForChanges(changes): string[]

Parameters

changes

NodePropertyChange[]

Returns

string[]

ontologyTermIrisForProperties()

ontologyTermIrisForProperties(properties): string[]

Parameters

properties

NodeProperty[]

Returns

string[]

OntologyTermsProvider()

OntologyTermsProvider(props): Element

Parameters

props

OntologyTermsProviderProps

Returns

Element

OntologyTermText()

OntologyTermText(props): Element

Parameters

props

OntologyTermTextProps

Returns

Element

OpenInPlatformLink(props): Element | null

Parameters

props

OpenInPlatformLinkProps

Returns

Element | null

operatorPhrase()

operatorPhrase(operator): string

Parameters

operator

ComparisonOperator

Returns

string

PanelLabel()

PanelLabel(props): Element

Parameters

props

PanelLabelProps

Returns

Element

parseDatalogRuleCached()

parseDatalogRuleCached(rule): ParseResult

Parameters

rule

string

Returns

ParseResult

parseFactStatement()

parseFactStatement(text): FactSpo | undefined

Parameters

text

string

Returns

FactSpo | undefined

parseGroundedDatalogRuleCached()

parseGroundedDatalogRuleCached(rule): ParseResult

Parameters

rule

string

Returns

ParseResult

predicateLabel()

predicateLabel(iriOrPrefixedName): string

Parameters

iriOrPrefixedName

string

Returns

string

predicatePrefix()

predicatePrefix(label): string

Parameters

label

string

Returns

string

presentRule()

presentRule(rule, groundedRule?): RulePresentation

Parameters

rule

string

groundedRule?

string

Returns

RulePresentation

PreviousValueCell()

PreviousValueCell(props): Element

Parameters

props
change

EntityChange

Returns

Element

ProofSubjectHeader()

ProofSubjectHeader(props): Element | null

Parameters

props

ProofSubjectHeaderProps

Returns

Element | null

ProofTree()

ProofTree(props): Element | null

Parameters

props

ProofTreeProps

Returns

Element | null

PropertyDiffView()

PropertyDiffView(props): Element

Parameters

props

PropertyDiffViewProps

Returns

Element

PropertyValue()

PropertyValue(props): Element

Parameters

props
currencyCode?

string | null

predicate?

string

predicateLabel?

string | null

value

string

valueScale?

number

Returns

Element

ProvenanceBadge()

ProvenanceBadge(props): Element

Parameters

props

ProvenanceBadgeProps

Returns

Element

rdfGraphToNodesAndEdges()

rdfGraphToNodesAndEdges(graph, granularity?, direction?): NodesAndEdges

Parameters

graph

RdfGraph

granularity?

"subject" | "subject-object" = "subject"

direction?

LayoutDirection = "LR"

Returns

NodesAndEdges

rdfGraphToSummaryNodesAndEdges()

rdfGraphToSummaryNodesAndEdges(graph, direction?): NodesAndEdges

Parameters

graph

RdfGraph

direction?

LayoutDirection = "LR"

Returns

NodesAndEdges

readStateBinding()

readStateBinding(binding): ActionPlanState

Parameters

binding

Bindings | undefined

Returns

ActionPlanState

RedirectEndpointProvider()

RedirectEndpointProvider(props): Element

Parameters

props

RedirectEndpointProviderProps

Returns

Element

registerShape()

registerShape(targetClass, shapeTurtle): void

Parameters

targetClass

string

shapeTurtle

string

Returns

void

replaceNodeChildren()

replaceNodeChildren(nodes, nodeId, children): EntityTreeNode[]

Parameters

nodes

EntityTreeNode[]

nodeId

string

children

EntityTreeNode[]

Returns

EntityTreeNode[]

resolveActionShape()

resolveActionShape(iri): object

Parameters

iri

string

Returns

object

descriptor

descriptor: ActionShapeDescriptor | undefined

spec

spec: ActionShapeSpec | undefined

resolveOpenInPlatformLink(props): ResolvedLink | undefined

Parameters

props

OpenInPlatformLinkProps

Returns

ResolvedLink | undefined

ruleForSelection()

ruleForSelection(tree, node): RuleSelection | undefined

Parameters

tree

NormalizedTree

node

NormalizedNode

Returns

RuleSelection | undefined

ruleHeadTerms()

ruleHeadTerms(rule): string[]

Parameters

rule

string

Returns

string[]

ruleHeadText()

ruleHeadText(rule): string

Parameters

rule

string

Returns

string

RuleNarrative()

RuleNarrative(props): Element

Parameters

props

RuleNarrativeProps

Returns

Element

RuleNarrativeSegments()

RuleNarrativeSegments(props): Element

Parameters

props

RuleNarrativeSegmentsProps

Returns

Element

RuleVariableTypes()

RuleVariableTypes(props): Element | null

Parameters

props

RuleVariableTypesProps

Returns

Element | null

sanitizeHtml()

sanitizeHtml(input): string

Parameters

input

string

Returns

string

sanitizeSparqlLiteral()

sanitizeSparqlLiteral(value): string

Parameters

value

string

Returns

string

selectPriorityPreviewFields()

selectPriorityPreviewFields(properties, hints, currencyCode?, options?): NodePropertyPreview[]

Parameters

properties

NodeProperty[]

hints

PreviewFieldHints

currencyCode?

string | null = null

options?

PriorityPreviewFieldsOptions = {}

Returns

NodePropertyPreview[]

serializeRdfGraph()

serializeRdfGraph(graph): Record<string, Record<string, unknown[]>>

Parameters

graph

RdfGraph

Returns

Record<string, Record<string, unknown[]>>

ShaclForm()

ShaclForm(props): ReactElement

Parameters

props

ShaclFormProps

Returns

ReactElement

ShaclFormProvider()

ShaclFormProvider(props): Element

Parameters

props

ShaclFormProviderProps

Returns

Element

shortenUri()

shortenUri(uri): string

Parameters

uri

string

Returns

string

SlackMessagePreview()

SlackMessagePreview(props): Element

Parameters

props

SlackMessagePreviewProps

Returns

Element

slackToMarkdown()

slackToMarkdown(input): string

Parameters

input

string

Returns

string

SparqlOptionsProvider()

SparqlOptionsProvider(props): Element

Parameters

props

SparqlOptionsProviderProps

Returns

Element

splitComputationTerm()

splitComputationTerm(text): { expression: string; result: string; } | undefined

Parameters

text

string

Returns

{ expression: string; result: string; } | undefined

statusFor()

statusFor(endedAt, errorMessage): ActivityStatus

Parameters

endedAt

string | null

errorMessage

string | null

Returns

ActivityStatus

StatusPill()

StatusPill(props): Element

Parameters

props
muted?

boolean

value

string

Returns

Element

statusPillColorClass()

statusPillColorClass(value): string

Parameters

value

string

Returns

string

stubNodeData()

stubNodeData(iri, label?): RDFNodeData

Parameters

iri

string

label?

string

Returns

RDFNodeData

subjectTypeTerm()

subjectTypeTerm(tree, subject): string | undefined

Parameters

tree

NormalizedTree

subject

string

Returns

string | undefined

SubstitutedFactNotice()

SubstitutedFactNotice(props): Element | null

Parameters

props

SubstitutedFactNoticeProps

Returns

Element | null

synthesizeDefaultPreview()

synthesizeDefaultPreview(shape): ChangeNode[] | null

Parameters

shape

ActionShapeSpec

Returns

ChangeNode[] | null

tableCoverageStatusFor()

tableCoverageStatusFor(shape): TableCoverageStatus

Parameters

shape

ActionShapeSpec

Returns

TableCoverageStatus

tableLevelForType()

tableLevelForType(targetRdfTypes): TableLevel | null

Parameters

targetRdfTypes

readonly string[]

Returns

TableLevel | null

textSegment()

textSegment(text): NarrativeSegment

Parameters

text

string

Returns

NarrativeSegment

titleCase()

titleCase(s): string

Parameters

s

string

Returns

string

toManualActions()

toManualActions(entities, options?): ManualAction[]

Parameters

entities

ManualActionEntity[]

options?

ManualActionReadOptions = {}

Returns

ManualAction[]

truncateText()

truncateText(text, maxLength?): string

Parameters

text

string

maxLength?

number = 52

Returns

string

TypeSummaryListView()

TypeSummaryListView(props): Element

Parameters

props

TypeSummaryListViewProps

Returns

Element

useActionPlanDetail()

useActionPlanDetail(config): object

Parameters

config

UseActionPlanDetailOptions

Returns

object

data

data: ActionPlanDetailModel | null

error

error: Error | null

isLoading

isLoading: boolean

useActionPlanDiff()

useActionPlanDiff(config): UseQueryResult<PlanDiffResult, Error>

Parameters

config

UseActionPlanDiffOptions

Returns

UseQueryResult<PlanDiffResult, Error>

useActionPlanEntityMetrics()

useActionPlanEntityMetrics(config): UseQueryResult<EntityMetricsResult, Error>

Parameters

config

UseActionPlanEntityMetricsOptions

Returns

UseQueryResult<EntityMetricsResult, Error>

useActionPlanExecutionProvenance()

useActionPlanExecutionProvenance(config): UseQueryResult<ActionPlanExecutionProvenanceResult, Error>

Parameters

config

UseActionPlanExecutionProvenanceOptions

Returns

UseQueryResult<ActionPlanExecutionProvenanceResult, Error>

useActionPlanGraph()

useActionPlanGraph(config): UseQueryResult<RdfGraph, Error>

Parameters

config

UseActionPlanGraphOptions

Returns

UseQueryResult<RdfGraph, Error>

useActionPlanProvenance()

useActionPlanProvenance(config): UseQueryResult<ProvenanceResult, Error>

Parameters

config

UseActionPlanProvenanceOptions

Returns

UseQueryResult<ProvenanceResult, Error>

useActionPlanSamples()

useActionPlanSamples(config): UseQueryResult<PlanSamplesResult, Error>

Parameters

config

UseActionPlanSamplesOptions

Returns

UseQueryResult<PlanSamplesResult, Error>

useActionPlansList()

useActionPlansList(config?): UseQueryResult<ActionPlansListResult, Error>

Parameters

config?

UseActionPlansListOptions = {}

Returns

UseQueryResult<ActionPlansListResult, Error>

useActivity()

useActivity(config): UseQueryResult<ActivityDetail | null, Error>

Parameters

config

UseActivityOptions

Returns

UseQueryResult<ActivityDetail | null, Error>

useActivityFeed()

useActivityFeed(config?): UseQueryResult<ActivityFeedResult, Error>

Parameters

config?

UseActivityFeedOptions = {}

Returns

UseQueryResult<ActivityFeedResult, Error>

useConnectedAccountEntityIris()

useConnectedAccountEntityIris(): object

Live set of connected-account entity IRIs in the datastore. Used to decide which nodes get the recursive entity-relation tree (integrations-backed, not a hardcoded type list).

Returns

object

iris

iris: ReadonlySet<string>

isLoading

isLoading: boolean

useConversationStarters()

useConversationStarters(): UseQueryResult<object[], Error>

Returns

UseQueryResult<object[], Error>

useEntities()

useEntities<S>(config): UseQueryResult<Entity<SchemaInterface<S>>[], Error>

Type Parameters

S

S extends Schema

Parameters

config

UseEntitiesOptions<S>

Returns

UseQueryResult<Entity<SchemaInterface<S>>[], Error>

useEntitiesByIris()

useEntitiesByIris<S>(config): UseQueryResult<(SchemaInterface<S> | undefined)[], Error>

Type Parameters

S

S extends Schema

Parameters

config

UseEntitiesByIrisOptions<S>

Returns

UseQueryResult<(SchemaInterface<S> | undefined)[], Error>

useEntity()

useEntity<S>(config): UseQueryResult<NoInfer_2<SchemaInterface<S> | null>, Error>

Type Parameters

S

S extends Schema

Parameters

config

UseEntityOptions<S>

Returns

UseQueryResult<NoInfer_2<SchemaInterface<S> | null>, Error>

useEntityLink(): EntityLinkComponent | undefined

Returns

EntityLinkComponent | undefined

useEntityNeighbors()

useEntityNeighbors(iri): object

Distinct IRI neighbors of an entity (outbound objects + inbound subjects), with an optional rdf:type and a display label (schema:name / rdfs:label / local name). Outbound rdf:type edges are excluded so class IRIs do not appear as tree rows.

Parameters

iri

string

Returns

object

isError

isError: boolean

isLoading

isLoading: boolean

neighbors

neighbors: EntityNeighbor[]

useEntityNodes()

useEntityNodes(iris): object

Parameters

iris

string[]

Returns

object

isLoading

isLoading: boolean

nodesByIri

nodesByIri: Map<string, object & object & object>

useEntityRelations()

useEntityRelations<S>(config): UseQueryResult<LensEntity<S> | null, Error>

Type Parameters

S

S extends Schema

Parameters

config

UseEntityRelationsOptions<S>

Returns

UseQueryResult<LensEntity<S> | null, Error>

useFactMeasure()

useFactMeasure(predicate?): MeasureKind | undefined

Parameters

predicate?

string

Returns

MeasureKind | undefined

useFactMeasures()

useFactMeasures(predicates): Map<string, MeasureKind>

Parameters

predicates

(string | undefined)[]

Returns

Map<string, MeasureKind>

useGraphContext()

useGraphContext(): GraphContextValue

Returns

GraphContextValue

useGraphTheme()

useGraphTheme(): GraphTheme

Returns

GraphTheme

useInvalidateManualActions()

useInvalidateManualActions(): (planGraphIri) => Promise<void>

Returns

(planGraphIri) => Promise<void>

useLensCount()

useLensCount<S>(config): UseQueryResult<number, Error>

Type Parameters

S

S extends Schema

Parameters

config

Omit<UseSparqlQueryOptions<S>, "iri">

Returns

UseQueryResult<number, Error>

useLensFind()

useLensFind<S>(config): UseQueryResult<LensEntity<S>[], Error>

Type Parameters

S

S extends Schema

Parameters

config

UseSparqlQueryOptions<S>

Returns

UseQueryResult<LensEntity<S>[], Error>

useLensFindByIri()

useLensFindByIri<S>(config): UseQueryResult<LensEntity<S> | null, Error>

Type Parameters

S

S extends Schema

Parameters

config

UseSparqlQueryOptions<S> & object

Returns

UseQueryResult<LensEntity<S> | null, Error>

useManualActions()

useManualActions(config): UseQueryResult<ManualAction[], Error>

Parameters

config

UseManualActionsOptions

Returns

UseQueryResult<ManualAction[], Error>

useManualActionsForPlans()

useManualActionsForPlans(config): UseQueryResult<Map<string, ManualAction[]>, Error>

Parameters

config

UseManualActionsForPlansOptions

Returns

UseQueryResult<Map<string, ManualAction[]>, Error>

useNodeExternalLink(data): ExternalLink | undefined

Parameters

data

RDFNodeData | undefined

Returns

ExternalLink | undefined

usePersonalDataResolution()

usePersonalDataResolution(predicate?): PersonalDataResolution

Parameters

predicate?

string

Returns

PersonalDataResolution

usePersonalDataResolutionFor()

usePersonalDataResolutionFor(predicates): Map<string, PersonalDataResolution>

Parameters

predicates

(string | undefined)[]

Returns

Map<string, PersonalDataResolution>

useRedirectEndpoint()

useRedirectEndpoint(): string

Returns

string

useShaclForm()

useShaclForm(): ShaclFormContextValue

Returns

ShaclFormContextValue

useSparqlConstruct()

useSparqlConstruct(config): UseQueryResult<RdfGraph, Error>

Parameters

config

UseSparqlConstructOptions

Returns

UseQueryResult<RdfGraph, Error>

useSparqlSelect()

useSparqlSelect(config): UseQueryResult<Bindings[], Error>

Parameters

config

UseSparqlSelectOptions

Returns

UseQueryResult<Bindings[], Error>

ValuePill()

ValuePill(props): Element

Parameters

props

ValuePillProps

Returns

Element

variableSegment()

variableSegment(name): NarrativeSegment

Parameters

name

string

Returns

NarrativeSegment

WhyAffordance()

WhyAffordance(props): Element | null

Parameters

props
change

EntityChange

Returns

Element | null

withOntologyLabels()

withOntologyLabels(properties, terms): NodeProperty[]

Parameters

properties

NodeProperty[]

terms

Map<string, OntologyTerm>

Returns

NodeProperty[]

withOntologyPredicateLabels()

withOntologyPredicateLabels(changes, terms): NodePropertyChange[]

Parameters

changes

NodePropertyChange[]

terms

Map<string, OntologyTerm>

Returns

NodePropertyChange[]

References

ActivityChangeGroup

Re-exports ActivityChangeGroup

ActivityChangeKind

Re-exports ActivityChangeKind

ActivityChangeSetResult

Re-exports ActivityChangeSetResult

ActivityChangeTriple

Re-exports ActivityChangeTriple

ActivityFieldDiff

Re-exports ActivityFieldDiff

createSparqlOptions

Re-exports createSparqlOptions

createTypedLens

Re-exports createTypedLens

decodeSkolem

Re-exports decodeSkolem

EntityView

Re-exports EntityView

EntityViewProps

Re-exports EntityViewProps

extractLabel

Re-exports extractLabel

extractTypeName

Re-exports extractTypeName

formatPropertyLabel

Re-exports formatPropertyLabel

isBlankNode

Re-exports isBlankNode

LayoutDirection

Re-exports LayoutDirection

NodeRelation

Re-exports NodeRelation

OnNodeContextMenu

Re-exports OnNodeContextMenu

PropertyChange

Re-exports PropertyChange

PropertyChangeType

Re-exports PropertyChangeType

RDFNode

Re-exports RDFNode

RDFNodeData

Re-exports RDFNodeData

RDFNodeType

Re-exports RDFNodeType

SampleInstance

Re-exports SampleInstance

SkolemPart

Re-exports SkolemPart

SparqlEngineConfig

Re-exports SparqlEngineConfig

useActivityChangeSet

Re-exports useActivityChangeSet

useSparqlEngine

Re-exports useSparqlEngine

useSparqlOptions

Re-exports useSparqlOptions

useSparqlWriteOptions

Re-exports useSparqlWriteOptions

withAbortSignal

Re-exports withAbortSignal