StructureOutputJson
    Preparing search index...

    Type Alias List

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

    Properties

    groupId? items labelFormat level listId numberFormat? rect startValue? type

    Properties

    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.

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

    A 0-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

    numberFormat?: ListNumberFormat
    "none"
    rect: Rect
    startValue?: number

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

    1
    type: "list"

    Settings

    Member Visibility

    On This Page

    Properties