Class BlockPaletteManager

Hierarchy

BlockPaletteManager

Index

Constructors

Methods

addOrReplacePalette getPalette getPaletteIdList getPaletteItem getPrimaryPalette getSelectedBlockType getSelectedItem removePalette setPaletteItem setPrimaryPalette setSelectedItem

Constructors

`Private` constructor

new BlockPaletteManager(): BlockPaletteManager
Returns BlockPaletteManager

Methods

addOrReplacePalette

addOrReplacePalette(paletteId, palette): void
Parameters
- paletteId: string
- palette: BlockPalette
Returns void

Remarks
This function can't be called in read-only mode.

getPalette

getPalette(paletteId): BlockPalette
Parameters
- paletteId: string
Returns BlockPalette

getPaletteIdList

getPaletteIdList(): string[]
Returns string[]

getPaletteItem

getPaletteItem(paletteId, index): IBlockPaletteItem
Parameters
- paletteId: string
- index: number
Returns IBlockPaletteItem

Throws
This function can throw errors.

getPrimaryPalette

getPrimaryPalette(): BlockPalette
Returns BlockPalette

getSelectedBlockType

getSelectedBlockType(): BlockType
Returns BlockType

Throws
This function can throw errors.

getSelectedItem

getSelectedItem(): IBlockPaletteItem
Returns IBlockPaletteItem

removePalette

removePalette(paletteId): void
Parameters
- paletteId: string
Returns void

Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

setPaletteItem

setPaletteItem(paletteId, index, item): void
Parameters
- paletteId: string
- index: number
- item: IBlockPaletteItem
Returns void

Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

setPrimaryPalette

setPrimaryPalette(paletteId): void
Parameters
- paletteId: string
Returns void

Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

setSelectedItem

setSelectedItem(item): void
Parameters
- item: IBlockPaletteItem
Returns void

Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.