Interface GraphQLPointOfViewInput

Defines the transformation scope for one point of view passed to lx.getAllFactSheets().

  • factSheetIds — UUIDs of the plan/initiative Fact Sheets whose transformations should be applied. Pass an empty array [] to query the current workspace state.
  • pointInTime.date — ISO date string (e.g. '2025-12-31') for the target point in time. Takes precedence over milestoneId if both are non-null. null defaults to today.
  • pointInTime.milestoneId — UUID of a milestone to use as the point in time. Ignored if date is set. null defaults to today.

Example

// Query current state only
const current: lxr.GraphQLPointOfViewInput = {
factSheetIds: [],
pointInTime: { date: null, milestoneId: null }
};

// Project state after applying a specific initiative at end of year
const projected: lxr.GraphQLPointOfViewInput = {
factSheetIds: ['initiative-uuid'],
pointInTime: { date: '2025-12-31', milestoneId: null }
};
interface GraphQLPointOfViewInput {
    factSheetIds: string[];
    pointInTime: {
        date: null | string;
        milestoneId: null | string;
    };
}

Properties

factSheetIds: string[]
pointInTime: {
    date: null | string;
    milestoneId: null | string;
}

Type declaration

  • date: null | string
  • milestoneId: null | string

Generated using TypeDoc