Type Alias LinkPropTargetSheetV2

An optional property that a Link creator can specify to cause the client to navigate to a specific sheet in the generated Analytics Application when opening the generated Analytics Application from the selection Analytics Application's navpoint panel.

type LinkPropTargetSheetV2 = {
    context: LinkUsageContextV2;
    sheetId: string;
    sheetName?: string;
}
Index

An expression based on the usage environment of a Link typically including predicates that test the current user's membership in a group or possession of a user role that when evaluated truthfully enables an applicable value for a Link property. For example, User_* indicates that the link property setting applies to all users while User.name = joe indicates the rule applies only to a specific user named joe.

sheetId: string

The ID of the sheet to first navigate to when opening the generated Analytics Application from the selection Analytics Application.

sheetName?: string

An optional, read-only property that is returned when retrieving a link if the targetSheet setting exists for the current user in the link's properties set and the sheet with that ID exists in the link's templateApp.