Interface Palette

A Palette consists of a header and one or more rows of controls. The header can be opened or closed to show or hide the controls. Groups of Palettes are combined into SidePanels appearing to the left or right of a Shell.

Hierarchy

  • Palette

Index

Properties

label

label: string

Gets or sets the label shown in this palette's header.

locked

locked: boolean

Gets or sets whether the palette is locked. When locked, the user cannot open or close the palette; changing the open property still works.

open

open: boolean

Gets or sets whether the palette is open. When closed, only the header is visible.

rootElement

rootElement: HTMLElement

Gets the DOM element that contains the palette interface.

sidePanel

sidePanel: SidePanel

Gets the panel that contains this palette, or null if it is not in a panel.

Optional standardName

standardName: string

If this is a standard built-in palette, this property exists and names the type, such as "arithmetic".

Optional standardVariant

standardVariant: string

If this is a standard built-in palette, this property exists and names the variant, such as "standard".

Methods

dispose

  • dispose(): void
  • Permanently disposes of this palette. The palette is removed from its panel, if any, and associated resources are freed. The effects of using this palette after disposing of it are undefined.

    Returns void

This API is still under development and is subject to change. Copyright © Math I Can Do Solutions Incorporated and/or its licensors.