Represents a GridMaterial.

Hierarchy

  • GridMaterial

Implements

Constructors

  • Constructs a new GridMaterial.

    Parameters

    Returns GridMaterial

Properties

content: string

GridMaterial content.

grid: number

GridMaterial grid.

materialType: Chartlet

GridMaterial materialType.

Methods

  • Converts this GridMaterial to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Creates a new GridMaterial instance using the specified properties.

    Parameters

    Returns GridMaterial

    GridMaterial instance

  • Decodes a GridMaterial message from the specified reader or buffer.

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

    Parameters

    • reader: any

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns GridMaterial

    GridMaterial

  • Decodes a GridMaterial message from the specified reader or buffer, length delimited.

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

    Parameters

    • reader: any

      Reader or buffer to decode from

    Returns GridMaterial

    GridMaterial

  • Encodes the specified GridMaterial message. Does not implicitly verify messages.

    Parameters

    • message: IGridMaterial

      GridMaterial message or plain object to encode

    • Optional writer: any

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified GridMaterial message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IGridMaterial

      GridMaterial message or plain object to encode

    • Optional writer: any

      Writer to encode to

    Returns Writer

    Writer

  • Creates a GridMaterial message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns GridMaterial

    GridMaterial

  • Creates a plain object from a GridMaterial message. Also converts values to other types if specified.

    Parameters

    • message: GridMaterial

      GridMaterial

    • Optional options: any

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a GridMaterial message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc