Interface CommandInfo

Describes basic information about a command and how it is activated.

Hierarchy

  • CommandInfo

Index

Properties

Optional abbreviation

abbreviation: string

The default abbreviation used to activate the command, if any.

Optional gesture

gesture: string

The default gesture used to activate the command, if any. This is in the form of a gesture string as it would be passed to an input map, either a single typed character or a keystroke description such as "Ctrl X".

see

View.gestureMap

label

label: string

A version of the command name suitable for use as a label for a human reader.

Optional ligature

ligature: string

The primary ligature sequence, if any, that activates the command. This is a sequence of operator symbol keys, such as "<=", that will automatically be converted into the object produced by this command.

name

Name of the command.

section

section: string

Name of the section that the command belongs to.

sectionLabel

sectionLabel: string

A version of the section name suitable for use as a label for a human reader.

type

type: "chemistry" | "editing" | "math"

The general type of command, such as an editing command or a command that inserts a math object.

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