Interface ComponentDataRequirements

interface ComponentDataRequirements {
    description?: string;
    entities: ComponentEntityDataRequirement[];
    mode: "views" | "queries" | "hybrid";
    queries: ComponentQueryDataRequirement[];
}

Index

Properties

description? entities mode queries

Properties

`Optional`description

description?: string

Description of data access patterns

entities

entities: ComponentEntityDataRequirement[]

Describes the entities and fields the component will access to fulfill user requirements.

mode

mode: "views" | "queries" | "hybrid"

How the component gets its data

'views': Fetches data at runtime using MJ RunView()
'queries': Fetches data at runtime using MJ RunQuery()
'hybrid': Uses both views and queries, depending on the context

queries

queries: ComponentQueryDataRequirement[]

Stored Queries that the component will use to fetch data.