Skip to main content

Info

The info section defines the document info parameters.

favorite​

type: boolean

The highlighting state of the Favorite icon. When the user clicks the icon, the onMetaChange event is called. If the parameter is undefined or null, the Favorite icon is not displayed at the editor window header.

Example: true

Favorite

folder​

type: string

The folder where the document is stored. Can be empty if the document is in the root folder.

Example: "Example Files"

owner​

type: string

The name of the document owner/creator.

Example: "John Smith"

sharingSettings​

type: object[]

The information about the settings which allow sharing the document with other users.

Example:

[
  {
    isLink: false,
    permissions: "Full Access",
    user: "John Smith",
  },
]

type: boolean

Whether to replace the user icon with the link icon.

Example: false

sharingSettings.permissions​

type: string

The access rights for the user with the name above.

Example: "Full Access"

sharingSettings.user​

type: string

The name of the user the document will be shared with.

Example: "John Smith"

Sharing settingsSharing settings

uploaded​

type: string

The document uploading date.

Example: "2010-07-07 3:46 PM"

Document informationDocument information

Example​

const config = {
  // ...
  document: {
    // ...
    info: {
      favorite: false,
      folder: "Example Files",
      owner: "John Smith",
      sharingSettings: [
        {
          isLink: false,
          permissions: "Full Access",
          user: "John Smith",
        },
      ],
      uploaded: "2010-07-07 3:46 PM",
    },
  },
};

const docEditor = new DocsAPI.DocEditor("placeholder", config);