IAnalyticalDesignerVisualizationAccessProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props of the visualization access.
export interface IAnalyticalDesignerVisualizationAccessProps extends IAnalyticalDesignerHeaderContext
Extends: IAnalyticalDesignerHeaderContext
Remarks
Analytical Designer resolves this slot also where its own sharing is unavailable, for example when a host embeds it, so that the host can render its own access control there. The access level is read only after onRequestAccessSummary is called.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Access level of the visualization: | |||
boolean | (ALPHA) Whether the user may change who can open the visualization. | ||
boolean | (ALPHA) Whether the access level could not be read. | ||
boolean | (ALPHA) Whether the access level is being read. | ||
boolean | (ALPHA) Whether the built-in sharing is available. The default renders nothing when it is not. | ||
string | (ALPHA) Title of the visualization for the sharing UI, with the untitled placeholder for an empty title. | ||
() => void | (ALPHA) Starts reading the access level, once. Ignored when the built-in sharing is unavailable. | ||
(ALPHA) (Optional) The saved visualization whose access is managed. Undefined for a visualization that is not saved yet; its access is then a draft applied on its first save. |
Property details
IAnalyticalDesignerVisualizationAccessProps.accessLevelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Access level of the visualization: private when only its owner can open it, shared when some users or groups can, and public when everyone in the workspace can. Undefined until requested, while loading, or when the read failed.
accessLevel?: ShareStatus;
IAnalyticalDesignerVisualizationAccessProps.canManageAccesspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the user may change who can open the visualization.
canManageAccess: boolean;
IAnalyticalDesignerVisualizationAccessProps.isAccessErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the access level could not be read.
isAccessError: boolean;
IAnalyticalDesignerVisualizationAccessProps.isAccessLoadingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the access level is being read.
isAccessLoading: boolean;
IAnalyticalDesignerVisualizationAccessProps.isDefaultAvailablepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the built-in sharing is available. The default renders nothing when it is not.
isDefaultAvailable: boolean;
IAnalyticalDesignerVisualizationAccessProps.objectTitlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Title of the visualization for the sharing UI, with the untitled placeholder for an empty title.
objectTitle: string;
IAnalyticalDesignerVisualizationAccessProps.onRequestAccessSummarypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Starts reading the access level, once. Ignored when the built-in sharing is unavailable.
onRequestAccessSummary: () => void;
IAnalyticalDesignerVisualizationAccessProps.targetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The saved visualization whose access is managed. Undefined for a visualization that is not saved yet; its access is then a draft applied on its first save.
target?: IObjectPermissionsObject;