iterateViews Method

Iterate all ViewDefinitions matching the supplied query.

iterateViews(params: ViewQueryParams, callback: (view: ViewDefinition) => boolean): boolean

@returns true if all views were iterated, false if iteration was terminated early due to callback returning false.

Parameter Type Description
params ViewQueryParams Specifies the query by which views are selected.
callback (view: ViewDefinition) => boolean Function invoked for each ViewDefinition matching the query. Return false to terminate iteration, true to continue.

Returns - boolean

true if all views were iterated, false if iteration was terminated early due to callback returning false.

Defined in

Last Updated: 16 April, 2024