IExportMenuItem

Type interface

Export menu item interface.

Inheritance

IExportMenuItem does not extend any other symbol.

IExportMenuItem is not extended by any other symbol.

Properties

ascendants
#

Type List < IExportMenuItem >

Holds list of parent menu items to this item.

color
#

Type Color

Color to use as a background.

element
#

Type HTMLElement

Actual HTML element of the menu item.

format
#

Type string

Export format. (optional)

hidden
#

Type boolean

Should this item be hidden?

icon
#

Type string

A href of the image to show instead of a label.

id
#

Type string

A unique id to attach to the menu item.

interactions
#

Type InteractionObject

An InteractionObject representation of the menu item label.

label
#

Type string

Label to display in the menu.

menu
#

Type Array < IExportMenuItem >

An array of IExportMenuItem items, to construct a sub-menu out of.

An Export menu can have any number of nesting levels.

options
#

Type IExportSVGOptions | IExportImageOptions | IExportPDFOptions | IExportExcelOptions | IExportCSVOptions | IExportJSONOptions | IExportPrintOptions | IExportCustomOptions

Menu item options.

@see IExportOptions

svg
#

Type string

Raw SVG content to add to instead of regular label.

type
#

Type ...

Item type, usually an export format.

unsupported
#

Type boolean

If this is set to true, it means that this specific menu item is not supported by the current client system.

This is usually populated by Export's supported Adapter.

@see IExportAdapters