Commit 11e45d4b authored by Laurent Wouters's avatar Laurent Wouters
Browse files

Fixes some documentation about views

parent 639a29cc48ca
......@@ -31,6 +31,11 @@ import {
ViewResourceContentResolver
} from "./view-def";
/**
* Priority for a view that is not appropriate (must not be selected)
*/
export const VIEW_PRIORITY_INAPPROPRIATE = -1;
/**
* The implementation of a view
*/
......@@ -41,7 +46,9 @@ export interface ViewImplementation {
descriptor: ViewDescriptor;
/**
* Gets the view's priority (greater number indicate greater priority)
* Gets the view's priority
* - 0 to Number.MAX_SAFE_INTEGER for valid view with decreasing priority
* - -1 for inappropriate views (must not be selected)
* @param store The RDF store holding the data to be rendered
* @param target The target resource to be rendered
*/
......@@ -203,7 +210,7 @@ function resolveViewFor(
.map((id: string) => {
let impl = implementations[id];
return {
implementation: implementations[id],
implementation: impl,
priority: impl.priorityFor(store, target)
};
})
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment