Type alias List

List: {
    groupId?: number;
    items: (List | ListItem)[];
    labelFormat: string;
    level: number;
    listId: number;
    numberFormat?: ListNumberFormat;
    rect: Rect;
    startValue?: number;
    type: "list";
}

Type declaration

  • Optional groupId?: number

    a number used to identify elements that are semantically continuous, for example, a table that has broken across pages would be represented by multiple elements, but all with the same group ID

  • items: (List | ListItem)[]
  • labelFormat: string

    The label text. For an unordered list, this can be used in an unmodified form. For an ordered list, will contain placeholders for the ordered portion of the label. The placeholders are of the form "%1", "%2", and represent the ordering text in the format indicated by the labelFormat property.

    Example

    "%1: " would resolve to "A: " for the first item of a list with
    the numberFormat "upperAlpha"
  • level: number

    A 1-based number indicating the nesting level of this list

  • listId: number

    As a list can potentially be discontinuous, the listID can be used to indicate that different list objects belong to the same semantic group

  • Optional numberFormat?: ListNumberFormat

    Default

    "none"

  • rect: Rect
  • Optional startValue?: number

    A 1-based number indicating the starting value for this list

    Default

    1

  • type: "list"

Settings

Member Visibility

Theme