Interface: PageInfoApiV1

PageInfoApi.PageInfoApiV1

Description

Interface that returns information related to the current page

Properties

• getActiveSearchInfo
• getCurrentBrowser
• getFilters
• getRelationalField
• getSampleState
• getSorts
• onRelationalFieldChange

Properties

getActiveSearchInfo

• getActiveSearchInfo: () => ActiveSearchInfo

Type declaration

• (): ActiveSearchInfo

Returns

ActiveSearchInfo

Description

Allows the developer to get the active search or saved search information while on the Saved Search panel

getCurrentBrowser

• getCurrentBrowser: () => undefined | BrowserID

Type declaration

• (): undefined | BrowserID

Returns

undefined | BrowserID

Selected browser

Description

Allows the developer to get the current browser in use

getFilters

• getFilters: (workspaceID: number, artifactTypeID: number) => undefined | FilterBase

Type declaration

• (workspaceID, artifactTypeID): undefined | FilterBase

Parameters

Name	Type	Description
workspaceID	number	The current workspace ID
artifactTypeID	number	The current artifact type ID

Returns

undefined | FilterBase

The object containing filters applicable to the current state of the page.

Description

Allows the developer to get an object containing filters applicable to the current state of the page

getRelationalField

• getRelationalField: (workspaceID: number, artifactTypeID: number) => undefined | number

Type declaration

• (workspaceID, artifactTypeID): undefined | number

Parameters

Name	Type	Description
workspaceID	number	The current workspace ID
artifactTypeID	number	The current artifact type ID

Returns

undefined | number

The artifact ID of the currently selected relation field

Description

Allows the developer to get the relational field for the current document list

getSampleState

• getSampleState: (workspaceID: number, artifactTypeID: number) => undefined | Record<string, any>

Type declaration

• (workspaceID, artifactTypeID): undefined | Record<string, any>

Parameters

Name	Type	Description
workspaceID	number	The current workspace ID
artifactTypeID	number	The current artifact type ID

Returns

undefined | Record<string, any>

The mapping of the current sampling parameters

Description

Allows the developer to get an object containing the current state of the sampling parameters

getSorts

• getSorts: (workspaceID: number, artifactTypeID: number) => undefined | Record<string, any>

Type declaration

• (workspaceID, artifactTypeID): undefined | Record<string, any>

Parameters

Name	Type	Description
workspaceID	number	The current workspace ID
artifactTypeID	number	The current artifact type ID

Returns

undefined | Record<string, any>

The mapping of the current sorted columns

Description

Allows the developer to get an object containing the current sorted columns

onRelationalFieldChange

• onRelationalFieldChange: (handler: EventHandlerFunction) => void

Type declaration

• (handler): void

Parameters

Name	Type	Description
handler	EventHandlerFunction	The callback function to be triggered

Returns

void

Description

Allows the developer to register a callback triggered when the relational field changes