Interface ISimpleToolStatusBarOptions

A set of options which define the basic properties of a status bar item for a simple tool.

interface ISimpleToolStatusBarOptions {
    alignment: StatusBarAlignment;
    onFinalize?: (statusBar: ISimpleToolStatusBarComponent) => void;
    onHide?: (statusBar: ISimpleToolStatusBarComponent) => void;
    onShow?: (statusBar: ISimpleToolStatusBarComponent) => void;
    onTeardown?: (statusBar: ISimpleToolStatusBarComponent) => void;
    size: number;
    text: LocalizedString;
    visibility?: SimpleToolStatusBarVisibility;
}

Index

Properties

alignment onFinalize? onHide? onShow? onTeardown? size text visibility?

Properties

alignment

alignment: StatusBarAlignment

Remarks

The alignment of the status bar item within the parent status bar container

`Optional`onFinalize

onFinalize?: (statusBar: ISimpleToolStatusBarComponent) => void

`Optional`onHide

onHide?: (statusBar: ISimpleToolStatusBarComponent) => void

`Optional`onShow

onShow?: (statusBar: ISimpleToolStatusBarComponent) => void

`Optional`onTeardown

onTeardown?: (statusBar: ISimpleToolStatusBarComponent) => void

size

size: number

Remarks

The size of the status bar item within the parent status bar container

text

text: LocalizedString

Remarks

The text for the status bar item

`Optional`visibility

visibility?: SimpleToolStatusBarVisibility

Remarks

Determine the status bar visibility based on the existence and visibility of the tool's root property pane