Interface ShapeLibraryPaletteComponentProps

Props for the ShapeLibraryPaletteComponent

interface ShapeLibraryPaletteComponentProps {
    canvasStrokeWidth?: number;
    dataGenerator?: DataGeneratorFunction<ObjectData>;
    dragSize?: Size;
    fill?: string;
    iconSize?: Size;
    initialSet?: string;
    outline?: string;
    paletteStrokeWidth?: number;
    selectAfterDrop?: boolean;
    shapeLibrary?: ShapeLibraryImpl<ObjectData>;
    showAllMessage?: string;
    surface?: Surface;
}

Properties

canvasStrokeWidth? dataGenerator? dragSize? fill? iconSize? initialSet? outline? paletteStrokeWidth? selectAfterDrop? shapeLibrary? showAllMessage? surface?

Properties

OptionalcanvasStrokeWidth

canvasStrokeWidth?: number

Stroke width to use for shapes dropped on canvas. Defaults to 2.

OptionaldataGenerator

dataGenerator?: DataGeneratorFunction<ObjectData>

Optional data generator to allow you to specify initial data for some element to be dragged. Note that you cannot override the object's type with this function. The palette will set the new object's type to match the type of the element that the user is dragging from the palette.

OptionaldragSize

dragSize?: Size

Optional size to use for dragged elements.

Optionalfill

fill?: string

Optional fill color to use for dragged elements. This should be in RGB format, not a color like 'white' or 'cyan' etc.

OptionaliconSize

iconSize?: Size

Optional size to use for icons.

OptionalinitialSet

initialSet?: string

ID of the initial set to show, if any. When you have multiple shapes in a set you may want the palette to open up showing just one set.

Optionaloutline

outline?: string

Optional color to use for outline of dragged elements. Should be in RGB format.

OptionalpaletteStrokeWidth

paletteStrokeWidth?: number

Stroke width to use for shapes in palette. Defaults to 1.

OptionalselectAfterDrop

selectAfterDrop?: boolean

When true (which is the default), a newly dropped vertex will be set as the underlying Toolkit's selection.

OptionalshapeLibrary

shapeLibrary?: ShapeLibraryImpl<ObjectData>

The shape library to render.

Deprecated

As of 6.50.0 the palette will be retrieved by default from the surface it is attached to. In 7.x this prop will not be available.

OptionalshowAllMessage

showAllMessage?: string

Message to use for the 'show all' option in the shape set drop down when there is more than one set of shapes. Defaults to Show all.

Optionalsurface

surface?: Surface

Surface to attach the drag/drop to. Optional; this component can extract the Surface from a SurfaceProvider, or from being a child of a SurfaceComponent.

Settings

Member Visibility

On This Page

Properties
Version :