excel.chartfont.yml

### YamlMime:TSType
name: Excel.ChartFont
uid: 'excel!Excel.ChartFont:class'
package: excel!
fullName: Excel.ChartFont
summary: 'This object represents the font attributes (such as font name, font size, and color) for a chart object.'
remarks: |-
  \[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]

  #### Examples

  ```TypeScript
  // Set the chart title font to Calibri, size 10, bold, and the color red.
  await Excel.run(async (context) => { 
      const title = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title;
      title.format.font.name = "Calibri";
      title.format.font.size = 12;
      title.format.font.color = "#FF0000";
      title.format.font.italic =  false;
      title.format.font.bold = true;
      title.format.font.underline = "None";
      await context.sync();
  });
  ```
isPreview: false
isDeprecated: false
type: class
properties:
  - name: bold
    uid: 'excel!Excel.ChartFont#bold:member'
    package: excel!
    fullName: bold
    summary: Represents the bold status of font.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'bold: boolean;'
      return:
        type: boolean
  - name: color
    uid: 'excel!Excel.ChartFont#color:member'
    package: excel!
    fullName: color
    summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'color: string;'
      return:
        type: string
  - name: context
    uid: 'excel!Excel.ChartFont#context:member'
    package: excel!
    fullName: context
    summary: >-
      The request context associated with the object. This connects the add-in's process to the Office host
      application's process.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'context: RequestContext;'
      return:
        type: '<xref uid="excel!Excel.RequestContext:class" />'
  - name: italic
    uid: 'excel!Excel.ChartFont#italic:member'
    package: excel!
    fullName: italic
    summary: Represents the italic status of the font.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'italic: boolean;'
      return:
        type: boolean
  - name: name
    uid: 'excel!Excel.ChartFont#name:member'
    package: excel!
    fullName: name
    summary: 'Font name (e.g., "Calibri")'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name: string;'
      return:
        type: string
  - name: size
    uid: 'excel!Excel.ChartFont#size:member'
    package: excel!
    fullName: size
    summary: 'Size of the font (e.g., 11)'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'size: number;'
      return:
        type: number
  - name: underline
    uid: 'excel!Excel.ChartFont#underline:member'
    package: excel!
    fullName: underline
    summary: Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for details.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'underline: Excel.ChartUnderlineStyle | "None" | "Single";'
      return:
        type: '<xref uid="excel!Excel.ChartUnderlineStyle:enum" /> | "None" | "Single"'
methods:
  - name: load(options)
    uid: 'excel!Excel.ChartFont#load:member(1)'
    package: excel!
    fullName: load(options)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(options?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.ChartFontLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.ChartFont:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.ChartFont#load:member(2)'
    package: excel!
    fullName: load(propertyNames)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(propertyNames?: string | string[]): Excel.ChartFont;'
      parameters:
        - id: propertyNames
          description: A comma-delimited string or an array of strings that specify the properties to load.
          type: 'string | string[]'
      return:
        type: '<xref uid="excel!Excel.ChartFont:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.ChartFont#load:member(3)'
    package: excel!
    fullName: load(propertyNamesAndPaths)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: |-
        load(propertyNamesAndPaths?: {
                    select?: string;
                    expand?: string;
                }): Excel.ChartFont;
      parameters:
        - id: propertyNamesAndPaths
          description: >-
            `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
            `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
          type: |-
            {
                        select?: string;
                        expand?: string;
                    }
      return:
        type: '<xref uid="excel!Excel.ChartFont:class" />'
        description: ''
  - name: 'set(properties, options)'
    uid: 'excel!Excel.ChartFont#set:member(1)'
    package: excel!
    fullName: 'set(properties, options)'
    summary: >-
      Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
      properties, or another API object of the same type.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Interfaces.ChartFontUpdateData, options?: OfficeExtension.UpdateOptions): void;'
      parameters:
        - id: properties
          description: >-
            A JavaScript object with properties that are structured isomorphically to the properties of the object on
            which the method is called.
          type: '<xref uid="excel!Excel.Interfaces.ChartFontUpdateData:interface" />'
        - id: options
          description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
          type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
      return:
        type: void
        description: ''
  - name: set(properties)
    uid: 'excel!Excel.ChartFont#set:member(2)'
    package: excel!
    fullName: set(properties)
    summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Excel.ChartFont): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="excel!Excel.ChartFont:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.ChartFont#toJSON:member(1)'
    package: excel!
    fullName: toJSON()
    summary: >-
      Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
      `JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
      passed to it.) Whereas the original `Excel.ChartFont` object is an API object, the `toJSON` method returns a plain
      JavaScript object (typed as `Excel.Interfaces.ChartFontData`<!-- -->) that contains shallow copies of any loaded
      child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.ChartFontData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartFontData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'