Interface IBorders

ReadonlyisIBorders

getBottom

• getBottom(): IBorders.IStroke

  Returns IBorders.IStroke

  The bottom border.

getDiagonalDown

• getDiagonalDown(): IBorders.IStroke

  Returns IBorders.IStroke

  The diagonalDown border.

getDiagonalUp

• getDiagonalUp(): IBorders.IStroke

  Returns IBorders.IStroke

  The diagonalUp border.

getHorizontal

• getHorizontal(): IBorders.IStroke | null

  The inner horizontal rule — the border between rows, not around them.

  Returns IBorders.IStroke | null

  The authored inner stroke, or null when there is none to report.

  See

  IBorders.getVertical for when null is returned.

getLeft

• getLeft(): IBorders.IStroke

  Returns IBorders.IStroke

  The left border.

getProperties

• getProperties(): IBorders.Properties

  Returns all the set properties and their values for the border.

  Returns IBorders.Properties

getRight

• getRight(): IBorders.IStroke

  Returns IBorders.IStroke

  The right border.

getTop

• getTop(): IBorders.IStroke

  Returns IBorders.IStroke

  The top border.

getVertical

• getVertical(): IBorders.IStroke | null

  The inner vertical rule — the border between columns, not around them.

  Returns IBorders.IStroke | null

  The authored inner stroke, or null when there is none to report.

  Remarks

  An extent-scoped read, matching setVertical. Inner rules only exist across more than one column, so they are a property of a range, never of a cell — which is why this is the one border read that can answer null:

  • the border was materialized from a cell (or a 1-column range) — a cell has no inside;
  • the queried range is not covered by a single authored border block, so there is no one answer — re-query a range that is, or partition with getRegions('borders') to find one;
  • no inner rule is authored. Authoring None deletes the property rather than storing it, so "explicitly none" and "never set" are the same stored state and cannot be told apart — by design, not by omission.

  The edges (getLeft/getRight/…) are unaffected: a cell read still decomposes an inner rule into the per-cell edges it produces, which is what a cell actually carries.

isEmpty

• isEmpty(): boolean

  If there are any borders that are not none.

  Returns boolean

setBottom

• setBottom(
      stroke:
          | string
          | IBorders.IStroke
          | Partial<
              {
                  color?: | string
                  | IColor
                  | Partial<
                      {
                          adjust: | string
                          | ((adjustments: readonly Adjustment[]) => IColor)
                          | Partial<{}>
                          | null;
                          getAdjustments:
                              | string
                              | (() => readonly Adjustment[])
                              | Partial<{}>
                              | null;
                          getBaseColor: string | (() => IColor) | Partial<{}> | null;
                          getLastColor: string | (() => string | null) | Partial<{}> | null;
                          getType: string | (() => IColor.Type) | Partial<{}> | null;
                          getVal: string | (() => string) | Partial<{}> | null;
                          isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                          isIColor: string | true | null;
                          toBlackOrWhite:
                              | string
                              | ((darkMode?: boolean, threshold?: number) => IColor)
                              | Partial<{}>
                              | null;
                          toCSS:
                              | string
                              | ((mode?: CSSMode, alpha?: boolean) => string)
                              | Partial<{}>
                              | null;
                          toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                          toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                          toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                          toString: string | (() => string) | Partial<{}> | null;
                      },
                  >
                  | null;
                  style?: string
                  | null;
              },
          >
          | null,
      options?: UpdateOptions,
  ): IBorders

  Sets the bottom border.

  Parameters

  • stroke:
        | string
        | IBorders.IStroke
        | Partial<
            {
                color?: | string
                | IColor
                | Partial<
                    {
                        adjust: | string
                        | ((adjustments: readonly Adjustment[]) => IColor)
                        | Partial<{}>
                        | null;
                        getAdjustments:
                            | string
                            | (() => readonly Adjustment[])
                            | Partial<{}>
                            | null;
                        getBaseColor: string | (() => IColor) | Partial<{}> | null;
                        getLastColor: string | (() => string | null) | Partial<{}> | null;
                        getType: string | (() => IColor.Type) | Partial<{}> | null;
                        getVal: string | (() => string) | Partial<{}> | null;
                        isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                        isIColor: string | true | null;
                        toBlackOrWhite:
                            | string
                            | ((darkMode?: boolean, threshold?: number) => IColor)
                            | Partial<{}>
                            | null;
                        toCSS:
                            | string
                            | ((mode?: CSSMode, alpha?: boolean) => string)
                            | Partial<{}>
                            | null;
                        toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                        toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                        toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                        toString: string | (() => string) | Partial<{}> | null;
                    },
                >
                | null;
                style?: string
                | null;
            },
        >
        | null

    The border stroke.

  • Optionaloptions: UpdateOptions

  Returns IBorders

setDiagonalDown

• setDiagonalDown(
      stroke:
          | string
          | IBorders.IStroke
          | Partial<
              {
                  color?: | string
                  | IColor
                  | Partial<
                      {
                          adjust: | string
                          | ((adjustments: readonly Adjustment[]) => IColor)
                          | Partial<{}>
                          | null;
                          getAdjustments:
                              | string
                              | (() => readonly Adjustment[])
                              | Partial<{}>
                              | null;
                          getBaseColor: string | (() => IColor) | Partial<{}> | null;
                          getLastColor: string | (() => string | null) | Partial<{}> | null;
                          getType: string | (() => IColor.Type) | Partial<{}> | null;
                          getVal: string | (() => string) | Partial<{}> | null;
                          isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                          isIColor: string | true | null;
                          toBlackOrWhite:
                              | string
                              | ((darkMode?: boolean, threshold?: number) => IColor)
                              | Partial<{}>
                              | null;
                          toCSS:
                              | string
                              | ((mode?: CSSMode, alpha?: boolean) => string)
                              | Partial<{}>
                              | null;
                          toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                          toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                          toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                          toString: string | (() => string) | Partial<{}> | null;
                      },
                  >
                  | null;
                  style?: string
                  | null;
              },
          >
          | null,
      options?: UpdateOptions,
  ): IBorders

  Sets the diagonalDown border.

  Parameters

  • stroke:
        | string
        | IBorders.IStroke
        | Partial<
            {
                color?: | string
                | IColor
                | Partial<
                    {
                        adjust: | string
                        | ((adjustments: readonly Adjustment[]) => IColor)
                        | Partial<{}>
                        | null;
                        getAdjustments:
                            | string
                            | (() => readonly Adjustment[])
                            | Partial<{}>
                            | null;
                        getBaseColor: string | (() => IColor) | Partial<{}> | null;
                        getLastColor: string | (() => string | null) | Partial<{}> | null;
                        getType: string | (() => IColor.Type) | Partial<{}> | null;
                        getVal: string | (() => string) | Partial<{}> | null;
                        isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                        isIColor: string | true | null;
                        toBlackOrWhite:
                            | string
                            | ((darkMode?: boolean, threshold?: number) => IColor)
                            | Partial<{}>
                            | null;
                        toCSS:
                            | string
                            | ((mode?: CSSMode, alpha?: boolean) => string)
                            | Partial<{}>
                            | null;
                        toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                        toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                        toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                        toString: string | (() => string) | Partial<{}> | null;
                    },
                >
                | null;
                style?: string
                | null;
            },
        >
        | null

    The border stroke.

  • Optionaloptions: UpdateOptions

  Returns IBorders

setDiagonalUp

• setDiagonalUp(
      stroke:
          | string
          | IBorders.IStroke
          | Partial<
              {
                  color?: | string
                  | IColor
                  | Partial<
                      {
                          adjust: | string
                          | ((adjustments: readonly Adjustment[]) => IColor)
                          | Partial<{}>
                          | null;
                          getAdjustments:
                              | string
                              | (() => readonly Adjustment[])
                              | Partial<{}>
                              | null;
                          getBaseColor: string | (() => IColor) | Partial<{}> | null;
                          getLastColor: string | (() => string | null) | Partial<{}> | null;
                          getType: string | (() => IColor.Type) | Partial<{}> | null;
                          getVal: string | (() => string) | Partial<{}> | null;
                          isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                          isIColor: string | true | null;
                          toBlackOrWhite:
                              | string
                              | ((darkMode?: boolean, threshold?: number) => IColor)
                              | Partial<{}>
                              | null;
                          toCSS:
                              | string
                              | ((mode?: CSSMode, alpha?: boolean) => string)
                              | Partial<{}>
                              | null;
                          toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                          toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                          toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                          toString: string | (() => string) | Partial<{}> | null;
                      },
                  >
                  | null;
                  style?: string
                  | null;
              },
          >
          | null,
      options?: UpdateOptions,
  ): IBorders

  Sets the diagonalUp border.

  Parameters

  • stroke:
        | string
        | IBorders.IStroke
        | Partial<
            {
                color?: | string
                | IColor
                | Partial<
                    {
                        adjust: | string
                        | ((adjustments: readonly Adjustment[]) => IColor)
                        | Partial<{}>
                        | null;
                        getAdjustments:
                            | string
                            | (() => readonly Adjustment[])
                            | Partial<{}>
                            | null;
                        getBaseColor: string | (() => IColor) | Partial<{}> | null;
                        getLastColor: string | (() => string | null) | Partial<{}> | null;
                        getType: string | (() => IColor.Type) | Partial<{}> | null;
                        getVal: string | (() => string) | Partial<{}> | null;
                        isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                        isIColor: string | true | null;
                        toBlackOrWhite:
                            | string
                            | ((darkMode?: boolean, threshold?: number) => IColor)
                            | Partial<{}>
                            | null;
                        toCSS:
                            | string
                            | ((mode?: CSSMode, alpha?: boolean) => string)
                            | Partial<{}>
                            | null;
                        toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                        toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                        toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                        toString: string | (() => string) | Partial<{}> | null;
                    },
                >
                | null;
                style?: string
                | null;
            },
        >
        | null

    The border stroke.

  • Optionaloptions: UpdateOptions

  Returns IBorders

setHorizontal

• setHorizontal(
      stroke:
          | string
          | IBorders.IStroke
          | Partial<
              {
                  color?: | string
                  | IColor
                  | Partial<
                      {
                          adjust: | string
                          | ((adjustments: readonly Adjustment[]) => IColor)
                          | Partial<{}>
                          | null;
                          getAdjustments:
                              | string
                              | (() => readonly Adjustment[])
                              | Partial<{}>
                              | null;
                          getBaseColor: string | (() => IColor) | Partial<{}> | null;
                          getLastColor: string | (() => string | null) | Partial<{}> | null;
                          getType: string | (() => IColor.Type) | Partial<{}> | null;
                          getVal: string | (() => string) | Partial<{}> | null;
                          isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                          isIColor: string | true | null;
                          toBlackOrWhite:
                              | string
                              | ((darkMode?: boolean, threshold?: number) => IColor)
                              | Partial<{}>
                              | null;
                          toCSS:
                              | string
                              | ((mode?: CSSMode, alpha?: boolean) => string)
                              | Partial<{}>
                              | null;
                          toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                          toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                          toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                          toString: string | (() => string) | Partial<{}> | null;
                      },
                  >
                  | null;
                  style?: string
                  | null;
              },
          >
          | null,
      options?: UpdateOptions,
  ): IBorders

  Sets the horizontal borders for the range

  Parameters

  • stroke:
        | string
        | IBorders.IStroke
        | Partial<
            {
                color?: | string
                | IColor
                | Partial<
                    {
                        adjust: | string
                        | ((adjustments: readonly Adjustment[]) => IColor)
                        | Partial<{}>
                        | null;
                        getAdjustments:
                            | string
                            | (() => readonly Adjustment[])
                            | Partial<{}>
                            | null;
                        getBaseColor: string | (() => IColor) | Partial<{}> | null;
                        getLastColor: string | (() => string | null) | Partial<{}> | null;
                        getType: string | (() => IColor.Type) | Partial<{}> | null;
                        getVal: string | (() => string) | Partial<{}> | null;
                        isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                        isIColor: string | true | null;
                        toBlackOrWhite:
                            | string
                            | ((darkMode?: boolean, threshold?: number) => IColor)
                            | Partial<{}>
                            | null;
                        toCSS:
                            | string
                            | ((mode?: CSSMode, alpha?: boolean) => string)
                            | Partial<{}>
                            | null;
                        toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                        toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                        toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                        toString: string | (() => string) | Partial<{}> | null;
                    },
                >
                | null;
                style?: string
                | null;
            },
        >
        | null

    The border stroke.

  • Optionaloptions: UpdateOptions

    Update options.

  Returns IBorders

  Remarks

  This has no effect on a 1x1 range or cell.

setLeft

• setLeft(
      stroke:
          | string
          | IBorders.IStroke
          | Partial<
              {
                  color?: | string
                  | IColor
                  | Partial<
                      {
                          adjust: | string
                          | ((adjustments: readonly Adjustment[]) => IColor)
                          | Partial<{}>
                          | null;
                          getAdjustments:
                              | string
                              | (() => readonly Adjustment[])
                              | Partial<{}>
                              | null;
                          getBaseColor: string | (() => IColor) | Partial<{}> | null;
                          getLastColor: string | (() => string | null) | Partial<{}> | null;
                          getType: string | (() => IColor.Type) | Partial<{}> | null;
                          getVal: string | (() => string) | Partial<{}> | null;
                          isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                          isIColor: string | true | null;
                          toBlackOrWhite:
                              | string
                              | ((darkMode?: boolean, threshold?: number) => IColor)
                              | Partial<{}>
                              | null;
                          toCSS:
                              | string
                              | ((mode?: CSSMode, alpha?: boolean) => string)
                              | Partial<{}>
                              | null;
                          toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                          toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                          toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                          toString: string | (() => string) | Partial<{}> | null;
                      },
                  >
                  | null;
                  style?: string
                  | null;
              },
          >
          | null,
      options?: UpdateOptions,
  ): IBorders

  Sets the left border.

  Parameters

  • stroke:
        | string
        | IBorders.IStroke
        | Partial<
            {
                color?: | string
                | IColor
                | Partial<
                    {
                        adjust: | string
                        | ((adjustments: readonly Adjustment[]) => IColor)
                        | Partial<{}>
                        | null;
                        getAdjustments:
                            | string
                            | (() => readonly Adjustment[])
                            | Partial<{}>
                            | null;
                        getBaseColor: string | (() => IColor) | Partial<{}> | null;
                        getLastColor: string | (() => string | null) | Partial<{}> | null;
                        getType: string | (() => IColor.Type) | Partial<{}> | null;
                        getVal: string | (() => string) | Partial<{}> | null;
                        isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                        isIColor: string | true | null;
                        toBlackOrWhite:
                            | string
                            | ((darkMode?: boolean, threshold?: number) => IColor)
                            | Partial<{}>
                            | null;
                        toCSS:
                            | string
                            | ((mode?: CSSMode, alpha?: boolean) => string)
                            | Partial<{}>
                            | null;
                        toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                        toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                        toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                        toString: string | (() => string) | Partial<{}> | null;
                    },
                >
                | null;
                style?: string
                | null;
            },
        >
        | null

    The border stroke.

  • Optionaloptions: UpdateOptions

  Returns IBorders

setOutline

• setOutline(
      stroke:
          | string
          | IBorders.IStroke
          | Partial<
              {
                  color?: | string
                  | IColor
                  | Partial<
                      {
                          adjust: | string
                          | ((adjustments: readonly Adjustment[]) => IColor)
                          | Partial<{}>
                          | null;
                          getAdjustments:
                              | string
                              | (() => readonly Adjustment[])
                              | Partial<{}>
                              | null;
                          getBaseColor: string | (() => IColor) | Partial<{}> | null;
                          getLastColor: string | (() => string | null) | Partial<{}> | null;
                          getType: string | (() => IColor.Type) | Partial<{}> | null;
                          getVal: string | (() => string) | Partial<{}> | null;
                          isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                          isIColor: string | true | null;
                          toBlackOrWhite:
                              | string
                              | ((darkMode?: boolean, threshold?: number) => IColor)
                              | Partial<{}>
                              | null;
                          toCSS:
                              | string
                              | ((mode?: CSSMode, alpha?: boolean) => string)
                              | Partial<{}>
                              | null;
                          toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                          toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                          toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                          toString: string | (() => string) | Partial<{}> | null;
                      },
                  >
                  | null;
                  style?: string
                  | null;
              },
          >
          | null,
      options?: UpdateOptions,
  ): IBorders

  Sets the border outline for the range

  Parameters

  • stroke:
        | string
        | IBorders.IStroke
        | Partial<
            {
                color?: | string
                | IColor
                | Partial<
                    {
                        adjust: | string
                        | ((adjustments: readonly Adjustment[]) => IColor)
                        | Partial<{}>
                        | null;
                        getAdjustments:
                            | string
                            | (() => readonly Adjustment[])
                            | Partial<{}>
                            | null;
                        getBaseColor: string | (() => IColor) | Partial<{}> | null;
                        getLastColor: string | (() => string | null) | Partial<{}> | null;
                        getType: string | (() => IColor.Type) | Partial<{}> | null;
                        getVal: string | (() => string) | Partial<{}> | null;
                        isEqual: string | ((other: any) => boolean) | Partial<{}> | null;
                        isIColor: string | true | null;
                        toBlackOrWhite:
                            | string
                            | ((darkMode?: boolean, threshold?: number) => IColor)
                            | Partial<{}>
                            | null;
                        toCSS:
                            | string
                            | ((mode?: CSSMode, alpha?: boolean) => string)
                            | Partial<{}>
                            | null;
                        toHex: string | ((darkMode?: boolean) => HEX) | Partial<{}> | null;
                        toHSLA: string | ((darkMode?: boolean) => HSLA) | Partial<{}> | null;
                        toRGBA: string | ((darkMode?: boolean) => RGBA) | Partial<{}> | null;
                        toString: string | (() => string) | Partial<{}> | null;
                    },
                >
                | null;
                style?: string
                | null;
            },
        >
        | null

    The border stroke.

  • Optionaloptions: UpdateOptions

    Update options.

  Returns IBorders