@microsoft/cost-management-ux NPM

@microsoft/cost-management-ux

Installation

npm i @microsoft/cost-management-ux

Import Components

import {
  CostManagementApp,
  CostAnalysisPage,
  ScheduledEmailsPage
} from '@microsoft/cost-management-ux

CostAnalysisPage

Property	Description	Type	Default
defaultViewName	Default open view	string	-
scope	Scope	Scope \| string	-
openedBy	Page the component is rendered on	string	-
flights	List of features to enable	string[]	[]
featureFlags	Feature key value pairs	string[]	{}
isDarkTheme	Sets dark theme	boolean	false
locale	The user's currently selected locale	string	en-us
getAuthToken	Callback to get auth token for current user	() => Promise\<string>	-
sessionId	User's session id	string	-
log	Callback to log entries	(entries: ReadonlyArray\<LogEntry>) => void	-
trace	Callback to trace entries	(events: ReadonlyArray\<TelemetryEvent>) => void	-
flushDiagnostics	Callback to force upload of log entries	() => Promise\<void>	-
getEnvironmentValue	Callback to get the value of an entry from the environment	\<K extends keyof E, E>(key: K) => EK	-
publicUrl	path to static content	string	-
openBlade	Callback to open a blade	(bladeReference: BladeReference, options?: OpenBladeOptions) => Promise\<boolean>	-
openContextPane	Callback to open a context pane	(bladeReference: BladeReference) => Promise\<boolean>	-
getMenuBlade	Callback to get menu properties to control MenuBlade information	() => MenuBlade	-
closeCurrentBlade	Callback to close the current blade	(data?: ReadonlyStringMap\<any>) => Promise\<boolean>	-
setBladeOnPin	Callback executed when user clicks on 'pin' icon	(handler: (() => PartReference) \| null \| undefined) => void	-
publishNotification	Callback to publish a notification	(options: NotificationOptions) => void	-
getUserInfo	Callback to return signed-in user and directory info	() => Promise\<UserInfo>	-

CostManagementApp

Property	Description	Type	Default
defaultViewName	Default open view	string	-
scope	Scope	Scope \| string	-
openedBy	Page the component is rendered on	string	-
flights	List of features to enable	string[]	[]
featureFlags	Feature key value pairs	string[]	{}
isDarkTheme	Sets dark theme	boolean	false
locale	The user's currently selected locale	string	en-us
getAuthToken	Callback to get auth token for current user	() => Promise\<string>	-
sessionId	User's session id	string	-
log	Callback to log entries	(entries: ReadonlyArray\<LogEntry>) => void	-
trace	Callback to trace entries	(events: ReadonlyArray\<TelemetryEvent>) => void	-
flushDiagnostics	Callback to force upload of log entries	() => Promise\<void>	-
getEnvironmentValue	Callback to get the value of an entry from the environment	\<K extends keyof E, E>(key: K) => EK	-
publicUrl	path to static content	string	-
openBlade	Callback to open a blade	(bladeReference: BladeReference, options?: OpenBladeOptions) => Promise\<boolean>	-
openContextPane	Callback to open a context pane	(bladeReference: BladeReference) => Promise\<boolean>	-
getMenuBlade	Callback to get menu properties to control MenuBlade information	() => MenuBlade	-
closeCurrentBlade	Callback to close the current blade	(data?: ReadonlyStringMap\<any>) => Promise\<boolean>	-
setBladeOnPin	Callback executed when user clicks on 'pin' icon	(handler: (() => PartReference) \| null \| undefined) => void	-
publishNotification	Callback to publish a notification	(options: NotificationOptions) => void	-
getUserInfo	Callback to return signed-in user and directory info	() => Promise\<UserInfo>	-

ScheduledEmailsPage

Property	Description	Type	Default
viewId	View id to create scheduled email for	string	-
create	Default to opening form	boolean	false
viewDisplayName	Default view display name	string	-
viewDateRange	Default view date range	string	-
scope	Scope	Scope \| string	-
openedBy	Page the component is rendered on	string	-
flights	List of features to enable	string[]	[]
featureFlags	Feature key value pairs	string[]	{}
isDarkTheme	Sets dark theme	boolean	false
locale	The user's currently selected locale	string	en-us
getAuthToken	Callback to get auth token for current user	() => Promise\<string>	-
sessionId	User's session id	string	-
log	Callback to log entries	(entries: ReadonlyArray\<LogEntry>) => void	-
trace	Callback to trace entries	(events: ReadonlyArray\<TelemetryEvent>) => void	-
flushDiagnostics	Callback to force upload of log entries	() => Promise\<void>	-
getEnvironmentValue	Callback to get the value of an entry from the environment	\<K extends keyof E, E>(key: K) => EK	-
publicUrl	path to static content	string	-
openBlade	Callback to open a blade	(bladeReference: BladeReference, options?: OpenBladeOptions) => Promise\<boolean>	-
openContextPane	Callback to open a context pane	(bladeReference: BladeReference) => Promise\<boolean>	-
getMenuBlade	Callback to get menu properties to control MenuBlade information	() => MenuBlade	-
closeCurrentBlade	Callback to close the current blade	(data?: ReadonlyStringMap\<any>) => Promise\<boolean>	-
setBladeOnPin	Callback executed when user clicks on 'pin' icon	(handler: (() => PartReference) \| null \| undefined) => void	-
publishNotification	Callback to publish a notification	(options: NotificationOptions) => void	-
getUserInfo	Callback to return signed-in user and directory info	() => Promise\<UserInfo>	-