AdapTable Types Reference

LayoutTagOptions

Options for managing Tags in Layouts (used to enhance Layouts)

TypeScript
export interface

Properties

PropertyDescriptionDefault
autoCheckTagsForLayoutsAutomatically assumes that any LayoutExtensionObject is available in the current Layout if it has a tag with the Layouts name (or no tags at all)false
autoGenerateTagsForLayoutsAutomatically generate an AdaptableObjectTag for each Layoutfalse
isObjectExtendedInLayoutChecks if provided Adaptable Object is extended in given Layout

Property Details

autoCheckTagsForLayouts

Automatically assumes that any LayoutExtensionObject is available in the current Layout if it has a tag with the Layouts name (or no tags at all)

TypeScript
autoCheckTagsForLayouts?: boolean;
Default Value

false

Property Value

boolean

autoGenerateTagsForLayouts

Automatically generate an AdaptableObjectTag for each Layout

TypeScript
autoGenerateTagsForLayouts?: boolean | ((context: AutoGenerateTagsForLayoutsContext) => AdaptableObjectTag[]);
Default Value

false

Property Value

boolean | ((context:AutoGenerateTagsForLayoutsContext) =>AdaptableObjectTag[])

isObjectExtendedInLayout

Checks if provided Adaptable Object is extended in given Layout

TypeScript
isObjectExtendedInLayout?: (layoutExtendedContext: LayoutExtendedContext) => boolean;
Property Value

(layoutExtendedContext:LayoutExtendedContext) => boolean

PreviousLayoutStateNextLayoutViewOptions